home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-bin / x11r6.1 / include / x11 / xresource.h < prev    next >
Encoding:
C/C++ Source or Header  |  1996-10-17  |  11.5 KB  |  413 lines
  1. /* $XConsortium: Xresource.h,v 1.37 94/04/17 20:21:52 rws Exp $ */
  2.  
  3. /***********************************************************
  4.  
  5. Copyright (c) 1987, 1988  X Consortium
  6.  
  7. Permission is hereby granted, free of charge, to any person obtaining a copy
  8. of this software and associated documentation files (the "Software"), to deal
  9. in the Software without restriction, including without limitation the rights
  10. to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11. copies of the Software, and to permit persons to whom the Software is
  12. furnished to do so, subject to the following conditions:
  13.  
  14. The above copyright notice and this permission notice shall be included in
  15. all copies or substantial portions of the Software.
  16.  
  17. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
  20. X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  21. AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  22. CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23.  
  24. Except as contained in this notice, the name of the X Consortium shall not be
  25. used in advertising or otherwise to promote the sale, use or other dealings
  26. in this Software without prior written authorization from the X Consortium.
  27.  
  28.  
  29. Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts.
  30.  
  31.                         All Rights Reserved
  32.  
  33. Permission to use, copy, modify, and distribute this software and its 
  34. documentation for any purpose and without fee is hereby granted, 
  35. provided that the above copyright notice appear in all copies and that
  36. both that copyright notice and this permission notice appear in 
  37. supporting documentation, and that the name of Digital not be
  38. used in advertising or publicity pertaining to distribution of the
  39. software without specific, written prior permission.  
  40.  
  41. DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  42. ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
  43. DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
  44. ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  45. WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
  46. ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  47. SOFTWARE.
  48.  
  49. ******************************************************************/
  50.  
  51. #ifndef _XRESOURCE_H_
  52. #define _XRESOURCE_H_
  53.  
  54. /* You must include <X11/Xlib.h> before including this file */
  55.  
  56. /****************************************************************
  57.  ****************************************************************
  58.  ***                                                          ***
  59.  ***                                                          ***
  60.  ***          X Resource Manager Intrinsics                   ***
  61.  ***                                                          ***
  62.  ***                                                          ***
  63.  ****************************************************************
  64.  ****************************************************************/
  65.  
  66. _XFUNCPROTOBEGIN
  67.  
  68. /****************************************************************
  69.  *
  70.  * Memory Management
  71.  *
  72.  ****************************************************************/
  73.  
  74. extern char *Xpermalloc(
  75. #if NeedFunctionPrototypes
  76.     unsigned int    /* size */
  77. #endif
  78. );
  79.  
  80. /****************************************************************
  81.  *
  82.  * Quark Management
  83.  *
  84.  ****************************************************************/
  85.  
  86. typedef int     XrmQuark, *XrmQuarkList;
  87. #define NULLQUARK ((XrmQuark) 0)
  88.  
  89. typedef char *XrmString;
  90. #define NULLSTRING ((XrmString) 0)
  91.  
  92. /* find quark for string, create new quark if none already exists */
  93. extern XrmQuark XrmStringToQuark(
  94. #if NeedFunctionPrototypes
  95.     _Xconst char*     /* string */
  96. #endif
  97. );
  98.  
  99. extern XrmQuark XrmPermStringToQuark(
  100. #if NeedFunctionPrototypes
  101.     _Xconst char*     /* string */
  102. #endif
  103. );
  104.  
  105. /* find string for quark */
  106. extern XrmString XrmQuarkToString(
  107. #if NeedFunctionPrototypes
  108.     XrmQuark         /* quark */
  109. #endif
  110. );
  111.  
  112. extern XrmQuark XrmUniqueQuark(
  113. #if NeedFunctionPrototypes
  114.     void
  115. #endif
  116. );
  117.  
  118. #define XrmStringsEqual(a1, a2) (strcmp(a1, a2) == 0)
  119.  
  120.  
  121. /****************************************************************
  122.  *
  123.  * Conversion of Strings to Lists
  124.  *
  125.  ****************************************************************/
  126.  
  127. typedef enum {XrmBindTightly, XrmBindLoosely} XrmBinding, *XrmBindingList;
  128.  
  129. extern void XrmStringToQuarkList(
  130. #if NeedFunctionPrototypes
  131.     _Xconst char*    /* string */,
  132.     XrmQuarkList    /* quarks_return */
  133. #endif
  134. );
  135.  
  136. extern void XrmStringToBindingQuarkList(
  137. #if NeedFunctionPrototypes
  138.     _Xconst char*    /* string */,
  139.     XrmBindingList    /* bindings_return */,
  140.     XrmQuarkList    /* quarks_return */
  141. #endif
  142. );
  143.  
  144. /****************************************************************
  145.  *
  146.  * Name and Class lists.
  147.  *
  148.  ****************************************************************/
  149.  
  150. typedef XrmQuark     XrmName;
  151. typedef XrmQuarkList XrmNameList;
  152. #define XrmNameToString(name)        XrmQuarkToString(name)
  153. #define XrmStringToName(string)        XrmStringToQuark(string)
  154. #define XrmStringToNameList(str, name)    XrmStringToQuarkList(str, name)
  155.  
  156. typedef XrmQuark     XrmClass;
  157. typedef XrmQuarkList XrmClassList;
  158. #define XrmClassToString(c_class)    XrmQuarkToString(c_class)
  159. #define XrmStringToClass(c_class)    XrmStringToQuark(c_class)
  160. #define XrmStringToClassList(str,c_class) XrmStringToQuarkList(str, c_class)
  161.  
  162.  
  163.  
  164. /****************************************************************
  165.  *
  166.  * Resource Representation Types and Values
  167.  *
  168.  ****************************************************************/
  169.  
  170. typedef XrmQuark     XrmRepresentation;
  171. #define XrmStringToRepresentation(string)   XrmStringToQuark(string)
  172. #define    XrmRepresentationToString(type)   XrmQuarkToString(type)
  173.  
  174. typedef struct {
  175.     unsigned int    size;
  176.     XPointer        addr;
  177. } XrmValue, *XrmValuePtr;
  178.  
  179.  
  180. /****************************************************************
  181.  *
  182.  * Resource Manager Functions
  183.  *
  184.  ****************************************************************/
  185.  
  186. typedef struct _XrmHashBucketRec *XrmHashBucket;
  187. typedef XrmHashBucket *XrmHashTable;
  188. typedef XrmHashTable XrmSearchList[];
  189. typedef struct _XrmHashBucketRec *XrmDatabase;
  190.  
  191.  
  192. extern void XrmDestroyDatabase(
  193. #if NeedFunctionPrototypes
  194.     XrmDatabase        /* database */    
  195. #endif
  196. );
  197.  
  198. extern void XrmQPutResource(
  199. #if NeedFunctionPrototypes
  200.     XrmDatabase*    /* database */,
  201.     XrmBindingList    /* bindings */,
  202.     XrmQuarkList    /* quarks */,
  203.     XrmRepresentation    /* type */,
  204.     XrmValue*        /* value */
  205. #endif
  206. );
  207.  
  208. extern void XrmPutResource(
  209. #if NeedFunctionPrototypes
  210.     XrmDatabase*    /* database */,
  211.     _Xconst char*    /* specifier */,
  212.     _Xconst char*    /* type */,
  213.     XrmValue*        /* value */
  214. #endif
  215. );
  216.  
  217. extern void XrmQPutStringResource(
  218. #if NeedFunctionPrototypes
  219.     XrmDatabase*    /* database */,
  220.     XrmBindingList      /* bindings */,
  221.     XrmQuarkList    /* quarks */,
  222.     _Xconst char*    /* value */
  223. #endif
  224. );
  225.  
  226. extern void XrmPutStringResource(
  227. #if NeedFunctionPrototypes
  228.     XrmDatabase*    /* database */,
  229.     _Xconst char*    /* specifier */,
  230.     _Xconst char*    /* value */
  231. #endif
  232. );
  233.  
  234. extern void XrmPutLineResource(
  235. #if NeedFunctionPrototypes
  236.     XrmDatabase*    /* database */,
  237.     _Xconst char*    /* line */
  238. #endif
  239. );
  240.  
  241. extern  XrmQGetResource(
  242. #if NeedFunctionPrototypes
  243.     XrmDatabase        /* database */,
  244.     XrmNameList        /* quark_name */,
  245.     XrmClassList    /* quark_class */,
  246.     XrmRepresentation*    /* quark_type_return */,
  247.     XrmValue*        /* value_return */
  248. #endif
  249. );
  250.  
  251. extern Bool XrmGetResource(
  252. #if NeedFunctionPrototypes
  253.     XrmDatabase        /* database */,
  254.     _Xconst char*    /* str_name */,
  255.     _Xconst char*    /* str_class */,
  256.     char**        /* str_type_return */,
  257.     XrmValue*        /* value_return */
  258. #endif
  259. );
  260.  
  261. extern Bool XrmQGetSearchList(
  262. #if NeedFunctionPrototypes
  263.     XrmDatabase        /* database */,
  264.     XrmNameList        /* names */,
  265.     XrmClassList    /* classes */,
  266.     XrmSearchList    /* list_return */,
  267.     int            /* list_length */
  268. #endif
  269. );
  270.  
  271. extern Bool XrmQGetSearchResource(
  272. #if NeedFunctionPrototypes
  273.     XrmSearchList    /* list */,
  274.     XrmName        /* name */,
  275.     XrmClass        /* class */,
  276.     XrmRepresentation*    /* type_return */,
  277.     XrmValue*        /* value_return */
  278. #endif
  279. );
  280.  
  281. /****************************************************************
  282.  *
  283.  * Resource Database Management
  284.  *
  285.  ****************************************************************/
  286.  
  287. extern void XrmSetDatabase(
  288. #if NeedFunctionPrototypes
  289.     Display*        /* display */,
  290.     XrmDatabase        /* database */
  291. #endif
  292. );
  293.  
  294. extern XrmDatabase XrmGetDatabase(
  295. #if NeedFunctionPrototypes
  296.     Display*        /* display */
  297. #endif
  298. );
  299.  
  300. extern XrmDatabase XrmGetFileDatabase(
  301. #if NeedFunctionPrototypes
  302.     _Xconst char*    /* filename */
  303. #endif
  304. );
  305.  
  306. extern Status XrmCombineFileDatabase(
  307. #if NeedFunctionPrototypes
  308.     _Xconst char*     /* filename */,
  309.     XrmDatabase*    /* target */,
  310.     Bool        /* override */
  311. #endif
  312. );
  313.  
  314. extern XrmDatabase XrmGetStringDatabase(
  315. #if NeedFunctionPrototypes
  316.     _Xconst char*    /* data */  /*  null terminated string */
  317. #endif
  318. );
  319.  
  320. extern void XrmPutFileDatabase(
  321. #if NeedFunctionPrototypes
  322.     XrmDatabase        /* database */,
  323.     _Xconst char*    /* filename */
  324. #endif
  325. );
  326.  
  327. extern void XrmMergeDatabases(
  328. #if NeedFunctionPrototypes
  329.     XrmDatabase        /* source_db */,
  330.     XrmDatabase*    /* target_db */
  331. #endif
  332. );
  333.  
  334. extern void XrmCombineDatabase(
  335. #if NeedFunctionPrototypes
  336.     XrmDatabase        /* source_db */,
  337.     XrmDatabase*    /* target_db */,
  338.     Bool        /* override */
  339. #endif
  340. );
  341.  
  342. #define XrmEnumAllLevels 0
  343. #define XrmEnumOneLevel  1
  344.  
  345. extern Bool XrmEnumerateDatabase(
  346. #if NeedFunctionPrototypes
  347.     XrmDatabase        /* db */,
  348.     XrmNameList        /* name_prefix */,
  349.     XrmClassList    /* class_prefix */,
  350.     int            /* mode */,
  351.     Bool (*)(
  352. #if NeedNestedPrototypes
  353.          XrmDatabase*    /* db */,
  354.          XrmBindingList    /* bindings */,
  355.          XrmQuarkList    /* quarks */,
  356.          XrmRepresentation*    /* type */,
  357.          XrmValue*        /* value */,
  358.          XPointer        /* closure */
  359. #endif
  360.          )        /* proc */,
  361.     XPointer        /* closure */
  362. #endif
  363. );
  364.  
  365. extern char *XrmLocaleOfDatabase(
  366. #if NeedFunctionPrototypes
  367.     XrmDatabase     /* database */
  368. #endif
  369. );
  370.  
  371.  
  372. /****************************************************************
  373.  *
  374.  * Command line option mapping to resource entries
  375.  *
  376.  ****************************************************************/
  377.  
  378. typedef enum {
  379.     XrmoptionNoArg,    /* Value is specified in OptionDescRec.value        */
  380.     XrmoptionIsArg,     /* Value is the option string itself            */
  381.     XrmoptionStickyArg, /* Value is characters immediately following option */
  382.     XrmoptionSepArg,    /* Value is next argument in argv            */
  383.     XrmoptionResArg,    /* Resource and value in next argument in argv      */
  384.     XrmoptionSkipArg,   /* Ignore this option and the next argument in argv */
  385.     XrmoptionSkipLine,  /* Ignore this option and the rest of argv        */
  386.     XrmoptionSkipNArgs    /* Ignore this option and the next 
  387.                OptionDescRes.value arguments in argv */
  388. } XrmOptionKind;
  389.  
  390. typedef struct {
  391.     char        *option;        /* Option abbreviation in argv        */
  392.     char        *specifier;     /* Resource specifier            */
  393.     XrmOptionKind   argKind;        /* Which style of option it is        */
  394.     XPointer        value;        /* Value to provide if XrmoptionNoArg   */
  395. } XrmOptionDescRec, *XrmOptionDescList;
  396.  
  397.  
  398. extern void XrmParseCommand(
  399. #if NeedFunctionPrototypes
  400.     XrmDatabase*    /* database */,
  401.     XrmOptionDescList    /* table */,
  402.     int            /* table_count */,
  403.     _Xconst char*    /* name */,
  404.     int*        /* argc_in_out */,
  405.     char**        /* argv_in_out */             
  406. #endif
  407. );
  408.  
  409. _XFUNCPROTOEND
  410.  
  411. #endif /* _XRESOURCE_H_ */
  412. /* DON'T ADD STUFF AFTER THIS #endif */
  413.