ff_cocoa_cppinterface.h

//
//  ff_cocoa_cppinterface.h
//  cocoatest
//
//  Created by Jari Williamsson on 2013-07-05.
//  Copyright (c) 2013 Jari Williamsson. All rights reserved.
//
 
#ifndef ff_cocoa_cppinterface_h
#define ff_cocoa_cppinterface_h
 
#include <tuple>
 
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
/* No officially documentation for the classes in this file */
 
class FCControl;
class __FCUserWindow;
class FCString;
class FCRange;
class FCRanges;
class FCCtrlDataList;
class FCCtrlTree;
class FCTreeNode;
class FCStrings;
class FCFontInfo;
class FCEnigmaTextStyle;
class FCVirtualCanvasInstructions;
 
#ifdef PDK_FRAMEWORK_STREAMS
class FCTextFileUTF8Stream;
#endif
 
#ifdef PDK_FRAMEWORK_FILEDIALOGS
class FCFileOpenDialog;
class FCFileSaveAsDialog;
class FCFolderBrowseDialog;
#endif
 
/* Maps a menu position to a menu command ID. */
typedef SInt32          EMENUID;
EMENUID _cocoalink_MapMenuPositionCommand(int mainmenuidx, int dropdownidx, int submenuidx);
EMENUID _cocoalink_MapMenuItemTextCommand(const FCString &topMenu, const FCString &itemText);
bool _cocoalink_ExecuteOSMenuCommand(EMENUID osmenucmd);
 
#ifdef PDK_FRAMEWORK_DEBUG
void _cocoalink_DebugOutMenuInfo(int menuixd_horiz, int menuixd_vert);
#endif
 
 
/* Modifies a NSValue by creating a new one to store a pointer value.
 * The old value is released and the new value object is returned.
 *
 * oldvalue: NSValue*
 * pointervalue: void*
 * return value: NSValue* 
 * Usage:
 * myvalue = _cocoalink_ChangeNSPointerValue(myvalue, ptr);
 */
void* _cocoalink_ChangeNSPointerValue(void* oldvalue, void* pointervalue);
 
/* Releases a NSValue object to clean it up.
 *
 * always returns nil.
 *
 * Parameter value: NSValue*
 */
void* _cocoalink_DeallocateNSValue(void* value);
 
/* Modifies a NSString by creating a new one to store a pointer value.
 * The old value is released and the new value object is returned.
 *
 * Intended ONLY to be called directly from FCString
 *
 * object: NSString*
 * pString: FCString*
 * return value: NSString*
 * Usage:
 * mynsstring = _cocoalink_GetNSString(mynsstring, pString);
 */
void* _cocoalink_GetNSString(void* object, const FCString* pString);
 
/* Implements Unicode ToLowerCase, using Cocoa
 *
 * Intended ONLY to be called directly from FCString
 *
 * fcstringobject: FCString*
 */
void _cocoalink_ToLowerCase(void* fcstringobject);
 
/* Implements Unicode ToUpperCase, using Cocoa
 *
 * Intended ONLY to be called directly from FCString
 *
 * fcstringobject: FCString*
 */
void _cocoalink_ToUpperCase(void* fcstringobject);
 
/* Converts a CFURLRef/NSURL to a path in pString. */
void _cocoalink_CFURLRefToPath(CFURLRef urlref, FCString* pString);
 
/* Converts a pString path to a CFURLRef */
CFURLRef _cocoalink_PathToCFURLRef(const FCString* pString);
 
/* Get document path from NSWindow */
bool __cocoalink_PathFromNSWindow(void* hWnd, FCString *pString); // can't use FXWND due to include dependencies
 
/* Sets a FCString to a NSString value.
 * Intended ONLY to be called directly from FCString
 *
 * pString: FCString*
 * object: NSString*
 * 
 */
void _cocoalink_SetNSString(FCString* pString, void* object);
 
/* Converts a FCString to a UTF8 char buffer */
bool _cocoalink_ToCharFromFCString(const FCString* pString, char* pszBuffer, const int maxsize, const bool preferPlatform);
inline bool _cocoalink_ToUTF8FromFCString(const FCString* pString, char* pszBuffer, const int maxsize)
{ return _cocoalink_ToCharFromFCString(pString, pszBuffer, maxsize, false); }
inline bool _cocoalink_ToCharFromFCString(const FCString* pString, char* pszBuffer, const int maxsize)
{ return _cocoalink_ToCharFromFCString(pString, pszBuffer, maxsize, true); }
 
/* Converts an UTF8 char buffer to a FCString */
bool _cocoalink_FromCharToFCString(FCString* pString, const char* pszBuffer, const bool preferPlatform);
inline bool _cocoalink_FromUTF8ToFCString(FCString* pString, const char* pszBuffer)
{
    if (_cocoalink_FromCharToFCString(pString, pszBuffer, false))
        return true;
    return _cocoalink_FromCharToFCString(pString, pszBuffer, true);
}
inline bool _cocoalink_FromCharToFCString(FCString* pString, const char* pszBuffer)
{
    if (_cocoalink_FromCharToFCString(pString, pszBuffer, true))
        return true;
    return _cocoalink_FromCharToFCString(pString, pszBuffer, false);
}
 
#ifdef PDK_FRAMEWORK_FORMAT
/* Basically a Unicode version of vsprintf(). Called from FCString::FormatString() */
int _cocoalink_FormatStringWithArguments(FCString* pStringDest, FCString* pStringArgs, va_list ap);
#endif
 
/* Releases a NSString object to clean it up (used by FCString).
 *
 * always returns nil.
 *
 * Parameter value: NSValue*
 */
void* _cocoalink_DeallocateNSString(void* object);
 
#ifdef PDK_FRAMEWORK_DIALOGS
/* Returns the modifier keys for the last notification in the queue
 *
 * Used by _FCWindowController_cocoa for window commands and by finenv
 * (in the Lua interpreter, which is currently RGP Lua) for menu invocation.
 *
 */
uint32_t _cocoalink_GetCurrentModifierKeys(); // use uint32_t instead of FLAG_32 because of #include file hell
 
bool _cocoalink_IsAppDarkModeAppearance();
 
#ifdef PDK_FRAMEWORK_IMAGECTRL
// The source parameter is FCCtrlImage::IMAGESOURCE, but due to include-file hell, we can't know that here.
void* _cocoalink_LoadImage(int source, const char* data, long dataLength, float* pWidth, float* pHeight); // returns NSImage* as void*
void _cocoalink_ReleaseImage(void* image);
#endif //PDK_FRAMEWORK_IMAGECTRL
#endif //PDK_FRAMEWORK_DIALOGS
 
/* Called from the static method FCUI::GetHiResTimer() */
double _fcuicocoa_GetHiResTimer();
 
class FCSystemGlyphInfo;
class FCFontInfo;
class _FCSystemGlyphInfo_cocoa
{
        FCSystemGlyphInfo* _pObject;
    public:
        _FCSystemGlyphInfo_cocoa(FCSystemGlyphInfo *pLinkedObject) { _pObject = pLinkedObject; }
    
        bool LoadInfo(FCFontInfo* pFontInfo, unsigned int glyphno);
};
 
class _FCUI_cocoa
{
    double _starttime, _resulttime; /* For high-precision timer */
public:
    _FCUI_cocoa(void);
    ~_FCUI_cocoa(void);
    
    void Beep();
    
    void AlertError(FCString* pMsg, FCString* pTitle);
    void AlertInfo(FCString* pMsg, FCString* pTitle);
    bool AlertOkCancel(FCString* pMsg, FCString* pTitle);
    bool AlertYesNo(FCString* pMsg, FCString* pTitle);
    int AlertYesNoCancel(FCString* pMsg, FCString* pTitle);
 
    bool IsFontAvailable(const char* pszFontName);
    
    void StartPerformanceTimer();
    void StopPerformanceTimer();
    double ReturnPerformanceTiming();
    
    bool DisplayWebURL(FCString* pURLString);
    bool DisplayShellFolder(FCString* pFolderString);
    
    bool TextToClipboard(const char* pszText, bool utf8);
    
    void GetDecimalSeparator(FCString* pString);
    void GetUserLocaleName(FCString* pString);
 
    /* return value is a EWND, which is a NSWindow* */
    void* GetActiveWindow();
    
    /* hwnd is a EWND, which is a NSWindow* */
    void ActivateWindow(void* hwnd);
};
 
class _FCStrings_cocoa
{
    FCStrings* _pLinkedObject;
public:
    _FCStrings_cocoa(FCStrings* pObject)
    {
        _pLinkedObject = pObject;
    }
    bool LoadFolderFiles(FCString* pFolderName);
    bool LoadSubfolders(FCString* pFolderName);
    bool LoadSystemFontNames();
};
 
#ifdef PDK_FRAMEWORK_STREAMS
class _FCTextFileUTF8Stream_cocoa
{
    FCTextFileUTF8Stream* _pLinkedObject;
public:
    _FCTextFileUTF8Stream_cocoa(FCTextFileUTF8Stream* pObject)
    {
        _pLinkedObject = pObject;
    }
    FCString* ReadString();
};
#endif
 
#ifdef PDK_FRAMEWORK_FILEDIALOGS
class _FCFileOpenDialog_cocoa
{
    FCFileOpenDialog* _pLinkedObject;
public:
    _FCFileOpenDialog_cocoa(FCFileOpenDialog* pObject)
    {
        _pLinkedObject = pObject;
    }
    bool Execute();
};
 
class _FCFileSaveAsDialog_cocoa
{
    FCFileSaveAsDialog* _pLinkedObject;
public:
    _FCFileSaveAsDialog_cocoa(FCFileSaveAsDialog* pObject)
    {
        _pLinkedObject = pObject;
    }
    bool Execute();
};
 
class _FCFolderBrowseDialog_cocoa
{
    FCFolderBrowseDialog* _pLinkedObject;
public:
    _FCFolderBrowseDialog_cocoa(FCFolderBrowseDialog* pObject)
    {
        _pLinkedObject = pObject;
    }
    
    bool Execute();
};
#endif
 
#ifdef PDK_FRAMEWORK_DIALOGS
 
struct __FloatRect
{
    float top;
    float left;
    float bottom;
    float right;
};
 
 
class _FCWindowController_cocoa
{
    bool _allowphysicalwindowclosing;  /* Flag to make sure that as window is only
                                        closed once (to prevent endless loops). */
    int _xibID;
    bool _ismodalstate;           /* This flags the current state */
    bool _ismodaldialog;          /* This flags what "display style" the window should be using. */
    __FCUserWindow* _pDialogOwner;  /* The PDK Framework object that owns this object. */
    bool _modelessCanBecomeMainWindow;  /* this field is accessed by RGP Lua and normally is false. */
    
public:
    _FCWindowController_cocoa(__FCUserWindow* pOwner, int xibID);
    virtual ~_FCWindowController_cocoa();
    
    /* Returns the dialog owner. */
    __FCUserWindow* GetDialogOwner() const { return _pDialogOwner; }
    
    /* Returns the objc id to the windowcontroller instance. */
    void* _GetInstance() { return _self; }
    
    /* Returns true iof the window controller should display the XIB as a modal dialog
     (with different approach to the Esc key for example) */
    bool IsModalDialog() { return _ismodaldialog; }
    
    bool ModelessCancelCanEscape() const;
    
    bool GetModelessCanBecomeMainWindow() const { return _modelessCanBecomeMainWindow; }
    void SetModelessCanBecomeMainWindow(bool state) { _modelessCanBecomeMainWindow = state; }
    
    void ShowModeless();
    
    /* Returns true if the dialog was displayed and closed. False on error.
     Get the modal state in the PDK Framework object to get the true modal
     return value.
     */
    bool ExecuteModal(__FCUserWindow* pParent);
    
    void NotYetImplementedError(const char* pszMethodName);
    
    void SetWindowCaption(FCString *pString);
 
    void GetWindowCaption(FCString *pString);
    
    void GetWindowContentRect(__FloatRect* pRect);
    void SetWindowFrameRect(__FloatRect* pRect);
    void GetWindowFrameRect(__FloatRect* pRect);
    float GetWindowTitleHeight();
    void SetMaximumResizeWidth(float width);
    void SetMaximumResizeHeight(float height);
    void SetWindowAlpha(int alphavalue);
    void SetInitialFocus();
    
    bool IsWindowLoaded() const;
    bool IsWindowVisible();
    bool IsDarkAppearanceMode() const;
    void ActivateWindow();
    void ShowWindow(bool showstate);
    void CloseWindow();
    void DestroyWindow();
    
    void RepaintWindow();
    
    /* Popup control stuff: */
    void ClearAllPopupItems(int dlgid);
    int GetPopupItemCount(int dlgid) const;
    void AppendPopupItem(int dlgid, FCString* pString);
    void InsertPopupString(int dlgid, int index, FCString* pString);    
    /* 0-based item idx */
    void DeletePopupItem(int dlgid, int lineidx);
    void SelectPopupItem(int dlgid, int lineidx);
    int GetSelectedPopupItem(int dlgid) const;
    bool GetPopupItemText(int dlgid, int lineidx, FCString* pString) const;
    bool AssurePopupWidthForText(int dlgid);
 
    /* Combo Box control stuff */
    void ClearAllComboBoxItems(int dlgid);
    int GetComboBoxItemCount(int dlgid);
    void AppendComboBoxItem(int dlgid, FCString* pString);
    int GetSelectedComboBoxItem(int dlgid);
    void SelectComboBoxItem(int dlgid, int lineidx);
    bool AssureComboBoxWidthForText(int dlgid);
 
    /* Clear shortcut key for a push button */
    void ClearShortcutKey(int dlgid);
    
    /* General Cocoa control stuff: */
    void* _GetCocoaID(int dlgid); /* Returns an objc id for a control with a specific tag */
    
    bool CreateUIControl(FCControl* pControl);
    
#ifdef PDK_FRAMEWORK_DIAGNOSE
    /* Retrieves the Cocoa class name (for diagnose mode). */
    void _GetControllerClassName(int dlgid, FCString* pClassName);
    bool IsSameClass(const FCString* pClassGot, const FCString* pClassExpected);
#endif
    
    void SetDlgItemVisible(int dlgid, bool show);
    bool GetDlgItemVisible(int dlgid);
    
    void SetDlgItemBold(int dlgid, bool boldstate);
    void SetDlgItemFont(int dlgid, const FCFontInfo *fontInfo);
    bool GetDlgItemFont(int dlgid, FCFontInfo *fontInfo);
    void SetDlgItemTextColor(int dlgid, int red, int green, int blue);
    void SetDlgItemKeyboardFocus(int dlgid);
    
    void SetDlgItemEnable(int dlgid, bool enable);
    bool GetDlgItemEnable(int dlgid) const;
    
    void SetDlgItemCheck(int dlgid, int state);
    int GetDlgItemCheck(int dlgid);
    
    bool AssureDlgItemWidthForText(int dlgid);
    void SetDlgItemText(int dlgid, const FCString* pString);
    void SetDlgItemTextAndResize(int dlgid, const FCString* pString);
    bool GetDlgItemText(int dlgid, FCString* pString);
    
    bool GetDlgItemRect(int dlgid, __FloatRect* pRect);
    void SetDlgItemWidth(int dlgid, float width);
    void SetDlgItemHeight(int dlgid, float height);
    void SetDlgItemPos(int dlgid, float x, float y, bool repaint = true);
    void SetDlgItemSize(int dlgid, float width, float height, bool repaint = true);
    
    bool RedrawDlgItemImmediate(int dlgid);
    
    /* "Stepper" controls in Cocoa: */
    void SetStepperMinMax(int dlgid, int min, int max);
    int GetStepperMin(int dlgid);
    int GetStepperMax(int dlgid);
    void SetStepperValue(int dlgid, int value);
 
    /* NSSlider controls in Cocoa: */
    void SetSliderMin(int dlgid, int value);
    int GetSliderMin(int dlgid);
    void SetSliderMax(int dlgid, int value);
    int GetSliderMax(int dlgid);
    void SetSliderThumbValue(int dlgid, int value);
    int GetSliderThumbValue(int dlgid);
    
    /* NSImageView */
    void SetImageForImageControl(int dlgid, void *image);
    
    /* NSTableView */
    void TableViewUseLeftCheckboxColumn(int dlgid);
    void TableViewSetNoHeader(int dlgid);
    void TableViewExpandLastColumn(int dlgid);
    int TableViewGetColumnCount(int dlgid,  bool includecheckboxcolumn);
    int TableViewGetColumnWidth(int dlgid, int columnindex);
    void TableViewSetColumnTitle(int dlgid, int columnindex, FCString* pTitle);
    bool TableViewAddColumn(int dlgid, FCString* pTitle, float columnwidth, int fontsize);
    void TableViewDeleteAllColumns(int dlgid);
    void TableViewRedraw(int dlgid);
    void TableViewScrollToTop(int dlgid);
    int TableViewGetSelectedLine(int dlgid);
    void TableViewSelectLine(int dlgid, int lineindex, bool ensurevisible, bool extendselection);
    bool TableViewIsLineSelected(int dlgid, int lineindex);
    bool TableViewHasCheckboxes(int dlgid);
    void TableViewUpdateCheckbox(int dlgid, int rowindex);
    void TableViewAssureConnected(FCCtrlDataList* pControl);
    void TableViewDeselectLine(int dlgid, int lineindex);
    void TableViewClearSelection(int dlgid);
    bool TableViewGetAlternatingRows(int dlgid) const;
    void TableViewSetAlternatingRows(int dlgid, bool value);
 
    /* NSOutlineView (the "tree view") */
    void OutlineViewSetupColumn(int dlgid, int fontheight);
    FCTreeNode* OutlineViewGetSelectedNode(int dlgid);
    bool OutlineViewCollapseAllContainers(int dlgid);
    bool OutlineViewExpandAllContainers(int dlgid);
    bool OutlineViewSetSelectedNode(int dlgid, FCTreeNode* pNode);
    bool OutlineViewExpandNode(int dlgid, FCTreeNode* pNode);
    void OutlineViewAssureConnected(FCCtrlTree* pControl);
    void OutlineViewRefreshData(int dlgid);
    
    /* Switcher (NSSegmentedControl) */
    void SwitcherAddPage(int dlgid, FCString* pString);
    int SwitcherGetPageCount(int dlgid);
    int SwitcherGetSelectedPage(int dlgid);
    void SwitcherSetSelectedPage(int dlgid, int index);
    
#ifdef PDK_FRAMEWORK_CANVASCTRL
    /* Canvas control (NSImageView) */
    void CanvasUpdateContent(int dlgid, FCVirtualCanvasInstructions* pInstructions);
#endif /* #ifdef PDK_FRAMEWORK_CANVASCONTROL */
    
    /* Text field */
    void EditScrollToBottom(int dlgid);
    
    /* Text editor control */
    bool TextEditorGetTotalTextRange(int dlgid, FCRange* pRange) const;
    int TextEditorGetLineForPosition(int dlgid, int pos) const;
    bool TextEditorGetLineRangeForLine(int dlgid, int line, FCRange* pRange) const;
    bool TextEditorGetLineRangeForPosition(int dlgid, int pos, FCRange* pRange) const;
    bool TextEditorGetSelection(int dlgid, FCRange* pRange) const;
    bool TextEditorSetSelection(int dlgid, const FCRange* pRange);
    bool TextEditorGetTextInRange(int dlgid, FCString *pText, const FCRange* pRange) const;
    bool TextEditorReplaceTextInRange(int dlgid, const FCString *pText, const FCRange* pRange);
    bool TextEditorReplaceTextInRangeWithFormat(int dlgid, const FCString* inp, const FCEnigmaTextStyle* pStyle, const FCRange* pRange, bool enabled);
    void TextEditorInsertTextAtCursor(int dlgid, const FCString *pText);
    FCString* TextEditorCreateRTFString(int dlgid) const;
    FCString* TextEditorCreateEnigmaString(int dlgid, const FCRange* pRange) const;
    bool TextEditorSetRTFString(int dlgid, const FCString* pString);
    FCFontInfo* TextEditorCreateFontInfoAtIndex(int dlgid, int index) const;
    bool TextEditorSetFontInRange(int dlgid, const FCFontInfo* pFont, const FCRange* pRange, bool enabled);
    bool TextEditorSetFontSizeInRange(int dlgid, int size, const FCRange* pRange, bool enabled);
    bool TextEditorSetFontBoldInRange(int dlgid, bool state, const FCRange* pRange, bool enabled);
    bool TextEditorSetFontItalicInRange(int dlgid, bool state, const FCRange* pRange, bool enabled);
    void TextEditorSetWordWrap(int dlgid, bool wordwrap);
    void TextEditorSetUseRichText(int dlgid, bool state);
    bool TextEditorGetUseRichText(int dlgid) const;
    void TextEditorSetAutomaticEditing(int dlgid, bool state);
    void TextEditorSetTabstopWidth(int dlgid, double value);
    FCRanges * TextEditorCreateRangesForString(int dlgid, const FCString* pSearchString, unsigned int options, const FCRange* pRange) const;
    void TextEditorResetUndoState(int dlgid);
    bool TextEditorSetColorInRange(int dlgid, int red, int green, int blue, bool reset, bool background, const FCRange* pRange, bool enabled);
    std::tuple<int, int, int> TextEditorGetColorAtIndex(int dlgid, int index, bool background) const;
    FCRanges* TextEditorGetColorChanges(int dlgid, bool background) const;
    int TextEditorGetNumberOfLines(int dlgid) const;
    double TextEditorGetVerticalScrollPosition(int dlgid) const;
    void TextEditorScrollToTop(int dlgid);
    void TextEditorScrollToBottom(int dlgid);
    void TextEditorScrollToVerticalPosition(int dlgid, double vpos);
    void TextEditorScrollToLine(int dlgid, int line);
    double TextEditorGetLineSpacing(int dlgid) const;
    void TextEditorSetLineSpacing(int dlgid, double value);
    FCString* TextEditorCreateCharacterAtIndex(int dlgid, int pos);
    bool TextEditorTextToClipboard(int dlgid, const FCRange* pRange) const; // works with NSTextField and NSTextView
    /* Text edit control or Text field control */
    void TextEditorSetReadOnly(int dlgid, bool readonly); // works with NSTextField and NSTextView
    bool TextEditorGetReadOnly(int dlgid) const; // works with NSTextField and NSTextView
 
    /* Timers */
    bool TimeridExists(int timerid);
    void CreateTimer(int timerid, int duration_in_ms);
    void KillTimer(int timerid);
    void KillAllTimers();
    void AssureTimers();
    
    /* Notification that the window has been setup. Call virtual InitWindow()
     method in PDK Framework. */
    void Notify_InitWindow();
 
    /* Notifications that are passed on to the PDK Framework */
    void Notify_OkButtonPressed();
    void Notify_CancelButtonPressed();
    void Notify_ButtonPressed(int controlid);
    void Notify_HandleCommand(int controlid);
    void Notify_TextSelectionChanged(int controlid);
    void Notify_ScrollChanged(int controlid);
    void Notify_DataListHandleDoubleClick(int controlid, int lineindex);
    void Notify_DataListHandleCommand(int controlid, int lineindex);
    void Notify_WindowActivated(bool activate);
    void Notify_WindowResized(float newwidth, float newheight, float oldwidth, float oldheight);
    void Notify_DarkModeIsChanging(bool isDarkMode);
    void Notify_OSMenuCommandExecuted(EMENUID menuCommand);
    void Notify_WindowClose();
    void Notify_HandleSwitcherSelect(int controlid, int switcherindex);
    void Notify_StepperPressed(void* sender, int controlid);
    void Notify_Timer(int timerid);
    void Notify_MouseTrackingStarted(FCControl *pControl);
    void Notify_MouseTrackingStopped(FCControl *pControl);
    bool Notify_WindowCanClose();
    bool Notify_HandleKeyboardCommand(FCControl *pControl, int character);
    
    /* Stores the currently pressed-down modifier keys in the __FCUserWindow object */
    void StoreModifierKeysToWindow();
private:
    void* _self;   /* Pointer to Objective-C++ instance. */
    
    void* alltimers; /* NSMutableArray object with all started timers */
};
#endif /* #ifdef PDK_FRAMEWORK_DIALOGS */
 
 
#endif /* #ifndef DOXYGEN_SHOULD_IGNORE_THIS */
 
 
#endif