workbench/libs/openurl/include/libraries/openurl.h

   1 #ifndef LIBRARIES_OPENURL_H
   2 #define LIBRARIES_OPENURL_H
   3
   4 /*
   5 **  $VER: openurl.h 7.2 (1.12.2005)
   6 **  Includes Release 7.2
   7 **
   8 **  openurl.library - universal URL display and browser
   9 **  launcher library
  10 **
  11 **  Written by Troels Walsted Hansen <troels@thule.no>
  12 **  Placed in the public domain.
  13 **
  14 **  Developed by:
  15 **  - Alfonso Ranieri <alforan@tin.it>
  16 **  - Stefan Kost <ensonic@sonicpulse.de>
  17 **
  18 */
  19
  20 #ifndef EXEC_TYPES_H
  21 #include <exec/types.h>
  22 #endif
  23
  24 #ifndef EXEC_LISTS_H
  25 #include <exec/lists.h>
  26 #endif
  27
  28 #ifndef EXEC_NODES_H
  29 #include <exec/nodes.h>
  30 #endif
  31
  32 #ifndef UTILITY_TAGITEM_H
  33 #include <utility/tagitem.h>
  34 #endif
  35
  36 #if defined(__PPC__)
  37   #if defined(__GNUC__)
  38     #pragma pack(2)
  39   #elif defined(__VBCC__)
  40     #pragma amiga-align
  41   #endif
  42 #endif
  43
  44 /**************************************************************************/
  45 /*
  46 ** Names
  47 */
  48
  49 #define OPENURLNAME "openurl.library"
  50 #define OPENURLVER  7
  51 #define OPENURLREV  2
  52
  53 /**************************************************************************/
  54 /*
  55 ** Tags
  56 */
  57
  58 #define URL_Tagbase                  ((int)0x81480000)
  59
  60 #define URL_Show                     (URL_Tagbase +  1) /* BOOL    - Uniconify browser                   */
  61 #define URL_BringToFront             (URL_Tagbase +  2) /* BOOL    - Bring browser to front              */
  62 #define URL_NewWindow                (URL_Tagbase +  3) /* BOOL    - Open URL in new window              */
  63 #define URL_Launch                   (URL_Tagbase +  4) /* BOOL    - Launch browser when not running     */
  64 #define URL_PubScreenName            (URL_Tagbase +  5) /* UBYTE * - Name of public screen to launch at  */
  65
  66 #define URL_GetPrefs_Mode            (URL_Tagbase + 20) /* BOOL    - Get default prefs                   */
  67 #define URL_GetPrefs_FallBack        (URL_Tagbase + 21) /* BOOL    - Do not fail (TRUE)                  */
  68
  69 #define URL_SetPrefs_Save            (URL_Tagbase + 30) /* BOOL    - Save prefs to ENVARC: also          */
  70
  71 #define URL_GetAttr_Version          (URL_Tagbase + 60) /* ULONG   - Library version                     */
  72 #define URL_GetAttr_Revision         (URL_Tagbase + 61) /* ULONG   - Library revision                    */
  73 #define URL_GetAttr_VerString        (URL_Tagbase + 62) /* STRPTR  - "openurl.library 6.4 (27.7.2005)"   */
  74 #define URL_GetAttr_PrefsVer         (URL_Tagbase + 63) /* ULONG   - Library preferences version         */
  75
  76 #define URL_GetAttr_HandlerVersion   (URL_Tagbase + 64) /* Obsolete !!! DON'T USE !!!                    */
  77 #define URL_GetAttr_HandlerRevision  (URL_Tagbase + 65) /* Obsolete !!! DON'T USE !!!                    */
  78 #define URL_GetAttr_HandlerVerString (URL_Tagbase + 66) /* Obsolete !!! DON'T USE !!!                    */
  79
  80 enum
  81 {
  82     URL_GetPrefs_Mode_Env,
  83     URL_GetPrefs_Mode_Envarc,
  84     URL_GetPrefs_Mode_Default,
  85     URL_GetPrefs_Mode_InUse,
  86 };
  87
  88 /**************************************************************************/
  89
  90 #define REXX_CMD_LEN       64
  91 #define NAME_LEN           32
  92 #define PATH_LEN          256
  93 #define PORT_LEN           32
  94
  95 #define SHOWCMD_LEN       REXX_CMD_LEN
  96 #define TOFRONTCMD_LEN    REXX_CMD_LEN
  97 #define OPENURLCMD_LEN    REXX_CMD_LEN
  98 #define OPENURLWCMD_LEN   REXX_CMD_LEN
  99 #define WRITEMAILCMD_LEN  (REXX_CMD_LEN*2)
 100
 101 /**************************************************************************/
 102 /*
 103 ** Version 4 Prefs
 104 */
 105
 106 #define PREFS_VERSION ((UBYTE)4)
 107
 108 struct URL_Prefs
 109 {
 110         UBYTE          up_Version;         /* always check this version number!     */
 111         struct MinList up_BrowserList;     /* list of struct URL_BrowserNodes       */
 112         struct MinList up_MailerList;      /* list of struct URL_MailerNodes        */
 113         struct MinList up_FTPList;         /* list of struct URL_MailerNodes        */
 114
 115         ULONG          up_Flags;           /* flags, see below                      */
 116
 117     ULONG          up_DefShow;         /* these BOOLs are the defaults for      */
 118         ULONG          up_DefBringToFront; /* the similarly named tags              */
 119         ULONG          up_DefNewWindow;    /* they are all new with Version 2       */
 120         ULONG          up_DefLaunch;
 121 };
 122
 123 /* up_Flags */
 124 enum
 125 {
 126     UPF_ISDEFAULTS  = 1<<0, /* structure contains the default settings     */
 127     UPF_PREPENDHTTP = 1<<1, /* prepend "http://" to URLs w/o scheme        */
 128     UPF_DOMAILTO    = 1<<2, /* mailto: URLs get special treatment          */
 129     UPF_DOFTP       = 1<<3, /* ftp:// URLs get special treatment           */
 130 };
 131
 132 /**************************************************************************/
 133 /*
 134 ** Common #?_Flags values
 135 */
 136
 137 enum
 138 {
 139     UNF_DISABLED = 1<<1,  /* The entry is disabled */
 140
 141     UNF_NEW      = 1<<16, /* Reserved for OpenURL preferences application */
 142     UNF_NTALLOC  = 1<<17, /* Reserved for OpenURL preferences application */
 143 };
 144
 145 /**************************************************************************/
 146 /*
 147 ** Browsers
 148 */
 149
 150 struct URL_BrowserNode
 151 {
 152         struct MinNode ubn_Node;
 153         ULONG          ubn_Flags;                        /* flags, see below                 */
 154         UBYTE          ubn_Name[NAME_LEN];               /* name of webbrowser                */
 155         UBYTE          ubn_Path[PATH_LEN];               /* complete path to browser          */
 156         UBYTE          ubn_Port[PORT_LEN];               /* webbrowser arexx port             */
 157         UBYTE          ubn_ShowCmd[SHOWCMD_LEN];         /* command to show/uniconify browser */
 158         UBYTE          ubn_ToFrontCmd[TOFRONTCMD_LEN];   /* command to bring browser to front */
 159         UBYTE          ubn_OpenURLCmd[OPENURLCMD_LEN];   /* command to open url               */
 160         UBYTE          ubn_OpenURLWCmd[OPENURLWCMD_LEN]; /* command to open url in new window */
 161 };
 162
 163 /* ubn_Flags */
 164 enum
 165 {
 166     /*
 167     ** If set, browser supports getting an URL on
 168     ** the commandline when launched. obsolete as
 169     ** of V3 - use %u on commandline instead
 170     */
 171     UBNF_URLONCMDLINE = 1<<0,
 172 };
 173
 174 /**************************************************************************/
 175 /*
 176 ** Mailers
 177 */
 178
 179 struct URL_MailerNode
 180 {
 181         struct MinNode umn_Node;
 182         ULONG          umn_Flags;                          /* flags, none defined              */
 183         UBYTE          umn_Name[NAME_LEN];                 /* name of mailer                   */
 184         UBYTE          umn_Path[PATH_LEN];                 /* complete path to mailer          */
 185         UBYTE          umn_Port[PORT_LEN];                 /* mailer arexx port                */
 186         UBYTE          umn_ShowCmd[SHOWCMD_LEN];           /* command to show/uniconify mailer */
 187         UBYTE          umn_ToFrontCmd[TOFRONTCMD_LEN];     /* command to bring mailer to front */
 188         UBYTE          umn_WriteMailCmd[WRITEMAILCMD_LEN]; /* command to write mail            */
 189 };
 190
 191 /**************************************************************************/
 192 /*
 193 ** FTPs
 194 */
 195
 196 struct URL_FTPNode
 197 {
 198         struct MinNode ufn_Node;
 199         ULONG          ufn_Flags;                        /* flags, see below                     */
 200         UBYTE          ufn_Name[NAME_LEN];               /* name of ftp client                   */
 201         UBYTE          ufn_Path[PATH_LEN];               /* complete path to ftp client          */
 202         UBYTE          ufn_Port[PORT_LEN];               /* webbrowser arexx port                */
 203         UBYTE          ufn_ShowCmd[SHOWCMD_LEN];         /* command to show/uniconify ftp client */
 204         UBYTE          ufn_ToFrontCmd[TOFRONTCMD_LEN];   /* command to bring ftp client to front */
 205         UBYTE          ufn_OpenURLCmd[OPENURLCMD_LEN];   /* command to open url                  */
 206         UBYTE          ufn_OpenURLWCmd[OPENURLWCMD_LEN]; /* command to open url in new window    */
 207 };
 208
 209 /* ufn_Flags */
 210 enum
 211 {
 212     /* If set, ftp:// ise removed from the URL */
 213     UFNF_REMOVEFTP = 1<<0,
 214 };
 215
 216 /**************************************************************************/
 217
 218 #if defined(__PPC__)
 219   #if defined(__GNUC__)
 220     #pragma pack()
 221   #elif defined(__VBCC__)
 222     #pragma default-align
 223   #endif
 224 #endif
 225
 226 #endif /* LIBRARIES_OPENURL_H */
 227