/* Copyright 2020 Jaakko Keränen Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #pragma once #include #include #include #include #include #include "prefs.h" #if defined (iPlatformAppleMobile) extern iBool isPhone_iOS(void); #endif iDeclareType(Bookmarks); iDeclareType(DocumentWidget); iDeclareType(CommandLine); iDeclareType(Gamepad); iDeclareType(GmCerts); iDeclareType(MainWindow); iDeclareType(MimeHooks); iDeclareType(Periodic); iDeclareType(Root); iDeclareType(Visited); iDeclareType(Window); typedef void iAnyWindow; /* Command line options strings. */ #define dump_CommandLineOption "dump;d" #define dumpIdentity_CommandLineOption "dump-identity;I" #define userDataDir_CommandLineOption "user;U" #define listTabUrls_CommandLineOption "list-tab-urls;L" #define openUrlOrSearch_CommandLineOption "url-or-search;u" #define replaceTab_CommandLineOption "replace-tab" #define windowWidth_CommandLineOption "width;w" #define windowHeight_CommandLineOption "height;h" #define uiTheme_CommandLineOption "theme;t" enum iAppDeviceType { desktop_AppDeviceType, tablet_AppDeviceType, phone_AppDeviceType, }; enum iAppEventMode { waitForNewEvents_AppEventMode, postedEventsOnly_AppEventMode, }; enum iUserEventCode { command_UserEventCode = 1, refresh_UserEventCode, asleep_UserEventCode, periodic_UserEventCode, /* The start of a potential touch tap event is notified via a custom event because sending SDL_MOUSEBUTTONDOWN would be premature: we don't know how long the tap will take, it could turn into a tap-and-hold for example. */ widgetTapBegins_UserEventCode, widgetTouchEnds_UserEventCode, /* finger lifted, but momentum may continue */ releaseObject_UserEventCode, /* object that needs releasing in the main thread */ }; enum iNewTabFlag { switchTo_NewTabFlag = iBit(1), append_NewTabFlag = iBit(2), reuseBlank_NewTabFlag = iBit(3), }; iLocalDef enum iAppDeviceType deviceType_App(void) { #if defined (iPlatformMobilePhone) return phone_AppDeviceType; #elif defined (iPlatformMobileTablet) return tablet_AppDeviceType; #elif defined (iPlatformAppleMobile) return isPhone_iOS() ? phone_AppDeviceType : tablet_AppDeviceType; #elif defined (iPlatformAndroidMobile) return phone_AppDeviceType; /* TODO: Java side could tell us via cmdline if this is a tablet. */ #else return desktop_AppDeviceType; #endif } int run_App (int argc, char **argv); void processEvents_App (enum iAppEventMode mode); iBool handleCommand_App (const char *cmd); void refresh_App (void); iBool isFinishedLaunching_App (void); iBool isRunningUnderWindowSystem_App(void); iBool isRunningUnderWayland_App (void); iBool isRefreshPending_App (void); iBool isSuspended_App (void); /* one should not be doing anything when suspended */ iBool isLandscape_App (void); iLocalDef iBool isPortrait_App (void) { return !isLandscape_App(); } iLocalDef iBool isPortraitPhone_App (void) { return isPortrait_App() && deviceType_App() == phone_AppDeviceType; } iLocalDef iBool isLandscapePhone_App (void) { return isLandscape_App() && deviceType_App() == phone_AppDeviceType; } uint32_t elapsedSinceLastTicker_App (void); /* milliseconds */ iBool isTextInputActive_App (void); const iPrefs * prefs_App (void); iBool forceSoftwareRender_App (void); void setForceSoftwareRender_App (iBool sw); void setInputZoomLevel_App (int level); void setEditorZoomLevel_App (int level); void setRecentMenuBarIndex_App (int index); enum iColorTheme colorTheme_App (void); const iString * schemeProxy_App (iRangecc scheme); iBool schemeProxyHostAndPort_App (iRangecc scheme, const iString **host, uint16_t *port); iBool willUseProxy_App (const iRangecc scheme); const iString * searchQueryUrl_App (const iString *queryStringUnescaped); const iString * fileNameForUrl_App (const iString *url, const iString *mime); const iString * temporaryPathForUrl_App (const iString *url, const iString *mime); /* deleted before quitting */ const iString * downloadPathForUrl_App (const iString *url, const iString *mime); const iString * execPath_App (void); const iString * dataDir_App (void); const iString * fontsDir_App (void); const iString * downloadDir_App (void); const iString * debugInfo_App (void); const iCommandLine *commandLine_App (void); iGmCerts * certs_App (void); iVisited * visited_App (void); iBookmarks * bookmarks_App (void); iMimeHooks * mimeHooks_App (void); iPeriodic * periodic_App (void); iRoot * submenuRoot_MacOS (void); iGamepad * gamepad_App (void); iDocumentWidget * document_App (void); iObjectList * listDocuments_App (const iRoot *rootOrNull); /* NULL for all roots of current window */ iStringSet * listOpenURLs_App (void); /* all tabs */ iDocumentWidget * newTab_App (const iDocumentWidget *duplicateOf, int newTabFlags); void trimCache_App (void); void trimMemory_App (void); void saveState_App (void); /* full save including cached content */ void saveStateQuickly_App (void); /* excluding cached content */ void deferVisitedSave_App (void); void setTextInputActive_App (iBool); const iStringArray *recentlySubmittedInput_App (void); void saveSubmittedInput_App (const iString *queryInput); void clearSubmittedInput_App (void); void setRecentMisfinId_App (const iGmIdentity *ident); iBool checkSavedWidth_App (const iString *resizeId, float *gaps_out); typedef void (*iTickerFunc)(iAny *); void addTicker_App (iTickerFunc ticker, iAny *context); void addTickerRoot_App (iTickerFunc ticker, iRoot *root, iAny *context); void removeTicker_App (iTickerFunc ticker, iAny *context); void addWindow_App (iMainWindow *win); void removeWindow_App (iMainWindow *win); iPtrArray * listWindows_App (void); void setActiveWindow_App (iAnyWindow *mainOrExtraWin); iWindow * activeWindow_App (void); void closeWindow_App (iWindow *win); /* main or extra window */ size_t numWindows_App (void); size_t windowIndex_App (const iMainWindow *win); void postRefreshAllWindows_App(void); iWindow * findWindow_App (int windowType, const char *widgetId); iMainWindow *newMainWindow_App (void); const iPtrArray *mainWindows_App (void); const iPtrArray *regularWindows_App (void); const iPtrArray *popupWindows_App (void); iMainWindow * mainWindow_App (void); /* currently active main window */ void addExtraWindow_App (iWindow *extra); void removeExtraWindow_App (iWindow *extra); void addPopup_App (iWindow *popup); void removePopup_App (iWindow *popup); void closePopups_App (iBool doForce); void postCommand_Root (iRoot *, const char *command); void postCommandf_Root (iRoot *, const char *command, ...); void postCommandf_App (const char *command, ...); iLocalDef void postCommandString_Root(iRoot *d, const iString *command) { if (command) { postCommand_Root(d, cstr_String(command)); } } iLocalDef void postCommand_App(const char *command) { postCommand_Root(NULL, command); } iDocumentWidget *document_Command (const char *cmd); iAny * findWidget_App (const char *id); iBool moveFocusWithArrows_App (const void *sdlEvent); iBool moveFocusInsideMenu_App (const void *sdlEvent); void commitFile_App (const char *path, const char *tempPathWithNewContents); /* latter will be removed */ void openInDefaultBrowser_App (const iString *url, const iString *mime); void revealPath_App (const iString *path); void updateCACertificates_App (void); void resetFonts_App (void); void availableFontsChanged_App (void);