home *** CD-ROM | disk | FTP | other *** search
/ Liren Large Software Subsidy 5 / 05.iso / a / a063 / 18.img / PBORCA.H < prev    next >
Encoding:
C/C++ Source or Header  |  1993-09-14  |  16.8 KB  |  315 lines
  1. /*                                                                         */
  2. /* *********************************************************************** */
  3. /*                                                                         */
  4. /*                 Copyright Powersoft Corporation 1990 - 1993             */
  5. /*                                                                         */
  6. /*       Powersoft Corporation ("Powersoft") claims copyright in this      */
  7. /*     program and documentation as an unpublished work, versions of       */
  8. /*     which were first licensed on the date indicated in the foregoing    */
  9. /*     notice. Claim of copyright does not imply waiver of Powersoft's     */
  10. /*     other rights. See Notice of Proprietary Rights.                     */
  11. /*                                                                         */
  12. /*                 NOTICE OF PROPRIETARY RIGHTS                            */
  13. /*                                                                         */
  14. /*       This program and documentation are confidential trade             */
  15. /*     secrets and the property of Powersoft.  Use, examination,           */
  16. /*     reproduction, copying, disassembly, decompilation, transfer         */
  17. /*     and/or disclosure to others are strictly prohibited except by       */
  18. /*     express written agreement with Powersoft.                           */
  19. /*                                                                         */
  20. /* ----------------------------------------------------------------------- */
  21. /*                                                                         */
  22. /*    Filename : pborca.h                                                  */
  23. /*                                                                         */
  24. /*    Purpose  : PowerBuilder Open Repository CASE API                     */
  25. /*                DLL public header file.                                  */
  26. /*                                                                         */
  27. /*    Notes    : 1. This header file should be included after <windows.h>  */
  28. /*                                                                         */
  29. /* *********************************************************************** */
  30.  
  31. #ifndef PB_ORCA                              /* First time defined?  */
  32. #define PB_ORCA                              /* Yes, make sure of it */
  33.  
  34. #ifndef CHAR                                 /* We have a CHAR definiton? */
  35. #define CHAR char                            /* No, then do it */
  36. #endif
  37.  
  38. /* *********************************************************************** */
  39. /* ORCA Interface assorted #defines                                        */
  40. /* *********************************************************************** */
  41.  
  42. #define HPBORCA           LPVOID             /* ORCA session handle */
  43. #define PBORCA_MSGBUFFER  256                /* Suggested msg buffer size */
  44. #define PBORCA_MAXCOMMENT 255                /* Maximum comment size */
  45.  
  46.  
  47. /* *********************************************************************** */
  48. /* ORCA Interface result #defines                                          */
  49. /* *********************************************************************** */
  50.  
  51. #define PBORCA_OK              0             /* Operation successful */
  52. #define PBORCA_INVALIDPARMS   -1             /* Invalid parameter list */
  53. #define PBORCA_DUPOPERATION   -2             /* Duplicate operation */    
  54. #define PBORCA_OBJNOTFOUND    -3             /* Object not found */ 
  55. #define PBORCA_BADLIBRARY     -4             /* Bad library name */
  56. #define PBORCA_LIBLISTNOTSET  -5             /* Library list not set */
  57. #define PBORCA_LIBNOTINLIST   -6             /* Library not in lib list */
  58. #define PBORCA_LIBIOERROR     -7             /* Library I/O error */          
  59. #define PBORCA_OBJEXISTS      -8             /* Object exists */          
  60. #define PBORCA_INVALIDNAME    -9             /* Invalid name */          
  61. #define PBORCA_BUFFERTOOSMALL -10            /* Buffer size is too small */          
  62. #define PBORCA_COMPERROR      -11            /* Compile error */
  63. #define PBORCA_LINKERROR      -12            /* Link error */
  64. #define PBORCA_CURRAPPLNOTSET -13            /* Current appl not set */
  65. #define PBORCA_OBJHASNOANCS   -14            /* Object has no ancestors */          
  66. #define PBORCA_OBJHASNOREFS   -15            /* Object has no references */          
  67.  
  68. /* *********************************************************************** */
  69. /* ORCA entry types                                                        */
  70. /* *********************************************************************** */
  71.  
  72. typedef enum pborca_type
  73. {
  74.  
  75.   PBORCA_APPLICATION,     
  76.   PBORCA_DATAWINDOW,      
  77.   PBORCA_FUNCTION,      
  78.   PBORCA_MENU,      
  79.   PBORCA_QUERY,      
  80.   PBORCA_STRUCTURE,      
  81.   PBORCA_USEROBJECT,      
  82.   PBORCA_WINDOW       
  83.  
  84. } PBORCA_TYPE, FAR *PPBORCA_TYPE;
  85.  
  86. typedef enum pborca_reftype
  87. {
  88.  
  89.   PBORCA_REFTYPE_SIMPLE,  
  90.   PBORCA_REFTYPE_OPEN  
  91.  
  92. } PBORCA_REFTYPE, FAR *PPBORCA_REFTYPE;
  93.  
  94. /* *********************************************************************** */
  95. /* Structure for PBORCA_CompileEntryImport callback function.              */
  96. /* *********************************************************************** */
  97. typedef struct pborca_comperr  
  98. {
  99.  
  100.   int            iLevel;                     /* Error level */
  101.   LPSTR          lpszMessageNumber;          /* Pointer to message number */ 
  102.   LPSTR          lpszMessageText;            /* Pointer to message text */ 
  103.   UINT           iColumnNumber;              /* Column number */
  104.   UINT             iLineNumber;                /* Line number */
  105.  
  106. } PBORCA_COMPERR, FAR *PPBORCA_COMPERR;
  107.  
  108. /* *********************************************************************** */
  109. /* Prototype for PBORCA_CompileEntryImport callback function.              */
  110. /* *********************************************************************** */
  111. typedef void (FAR PASCAL *PBORCA_ERRPROC) ( PPBORCA_COMPERR, LPVOID );
  112.  
  113.  
  114. /* *********************************************************************** */
  115. /* Structure for PBORCA_LibraryDirectory callback function.                */
  116. /* *********************************************************************** */
  117. typedef struct pborca_direntry 
  118. {
  119.                          /* Comments */
  120.   CHAR           szComments[PBORCA_MAXCOMMENT + 1];
  121.  
  122.   LONG           lCreateTime;                /* Time of entry create/mod */ 
  123.   LONG           lEntrySize;                 /* Size of entry */
  124.   LPSTR          lpszEntryName;              /* Pointer to entry name */
  125.   PBORCA_TYPE    otEntryType;                /* Entry type */
  126.  
  127. } PBORCA_DIRENTRY, FAR *PPBORCA_DIRENTRY;
  128.  
  129.  
  130. /* *********************************************************************** */
  131. /* Prototype for PBORCA_LibraryDirectory callback function.                */
  132. /* *********************************************************************** */
  133. typedef void (FAR PASCAL *PBORCA_LISTPROC) ( PPBORCA_DIRENTRY, LPVOID );
  134.  
  135.  
  136. /* *********************************************************************** */
  137. /* Structure for PBORCA_LibraryEntryInformation callback function.         */
  138. /* *********************************************************************** */
  139. typedef struct pborca_entryinfo 
  140. {
  141.                          /* Comments */
  142.   CHAR           szComments[PBORCA_MAXCOMMENT + 1];
  143.  
  144.   LONG           lCreateTime;                /* Time of entry create/mod */ 
  145.   LONG           lObjectSize;                /* Size of object */
  146.   LONG           lSourceSize;                /* Size of source */
  147.  
  148. } PBORCA_ENTRYINFO, FAR *PPBORCA_ENTRYINFO;
  149.  
  150.  
  151. /* *********************************************************************** */
  152. /* Structure for PBORCA_ObjectQueryHierarchy callback function.            */
  153. /* *********************************************************************** */
  154. typedef struct pborca_hierarchy
  155. {
  156.  
  157.   LPSTR          lpszAncestorName;           /* Pointer to ancestor name */ 
  158.  
  159. } PBORCA_HIERARCHY, FAR *PPBORCA_HIERARCHY;
  160.  
  161. /* *********************************************************************** */
  162. /* Prototype for PBORCA_ObjectQueryHierarchy callback function.            */
  163. /* *********************************************************************** */
  164. typedef void (FAR PASCAL *PBORCA_HIERPROC) ( PPBORCA_HIERARCHY, LPVOID );
  165.  
  166.  
  167. /* *********************************************************************** */
  168. /* Structure for PBORCA_ObjectQueryReference callback function.            */
  169. /* *********************************************************************** */
  170. typedef struct pborca_reference
  171. {
  172.  
  173.   LPSTR          lpszLibraryName;            /* Pointer to library name */ 
  174.   LPSTR          lpszEntryName;              /* Pointer to entry name */
  175.   PBORCA_TYPE    otEntryType;                /* Entry type */
  176.   PBORCA_REFTYPE otEntryRefType;             /* Entry reference type */
  177.  
  178. } PBORCA_REFERENCE, FAR *PPBORCA_REFERENCE;
  179.  
  180. /* *********************************************************************** */
  181. /* Prototype for PBORCA_ObjectQueryReference callback function.            */
  182. /* *********************************************************************** */
  183. typedef void (FAR PASCAL *PBORCA_REFPROC) ( PPBORCA_REFERENCE, LPVOID );
  184.  
  185.  
  186. /* *********************************************************************** */
  187. /* Session function prototypes                                             */
  188. /* *********************************************************************** */
  189.  
  190. void    FAR PASCAL PBORCA_SessionClose          ( HPBORCA hORCASession );
  191.  
  192. void    FAR PASCAL PBORCA_SessionGetError       ( HPBORCA hORCASession,
  193.                                                   LPSTR   lpszErrorBuffer,
  194.                                                   int     iErrorBufferSize );
  195.  
  196. HPBORCA FAR PASCAL PBORCA_SessionOpen           ( void );
  197.  
  198. int     FAR PASCAL PBORCA_SessionSetCurrentAppl ( HPBORCA hORCASession,
  199.                                                   LPSTR   lpszApplLibName,  
  200.                                                   LPSTR   lpszApplName );
  201.  
  202. int     FAR PASCAL PBORCA_SessionSetLibraryList ( HPBORCA    hORCASession,
  203.                                                   LPSTR FAR *pLibNames, 
  204.                                                   int        iNumberOfLibs );
  205.  
  206.  
  207. /* *********************************************************************** */
  208. /* Library management function prototypes                                  */
  209. /* *********************************************************************** */
  210.  
  211. int FAR PASCAL PBORCA_LibraryCommentModify ( HPBORCA hORCASession,
  212.                                              LPSTR   lpszLibName,  
  213.                                              LPSTR   lpszLibComments );
  214.  
  215. int FAR PASCAL PBORCA_LibraryCreate    ( HPBORCA hORCASession,
  216.                                          LPSTR   lpszLibName,  
  217.                                          LPSTR   lpszLibComments );
  218.  
  219. int FAR PASCAL PBORCA_LibraryDelete    ( HPBORCA hORCASession,
  220.                                          LPSTR   lpszLibName );   
  221.  
  222. int FAR PASCAL PBORCA_LibraryDirectory ( HPBORCA         hORCASession,
  223.                                          LPSTR           lpszLibName,       
  224.                                          LPSTR           lpszLibComments,  
  225.                                          int             iCmntsBuffSize, 
  226.                                          PBORCA_LISTPROC pListProc, 
  227.                                          LPVOID          pUserData );
  228.  
  229. int FAR PASCAL PBORCA_LibraryEntryCopy ( HPBORCA     hORCASession,
  230.                                          LPSTR       lpszSourceLibName,  
  231.                                          LPSTR       lpszDestLibName,  
  232.                                          LPSTR       lpszEntryName, 
  233.                                          PBORCA_TYPE otEntryType );
  234.  
  235. int FAR PASCAL PBORCA_LibraryEntryDelete ( HPBORCA     hORCASession,
  236.                                            LPSTR       lpszLibName,  
  237.                                            LPSTR       lpszEntryName, 
  238.                                            PBORCA_TYPE otEntryType );
  239.  
  240. int FAR PASCAL PBORCA_LibraryEntryExport ( HPBORCA     hORCASession,
  241.                                            LPSTR       lpszLibName,  
  242.                                            LPSTR       lpszEntryName, 
  243.                                            PBORCA_TYPE otEntryType,    
  244.                                            LPSTR       lpszExportBuffer, 
  245.                                            LONG        lExportBufferSize );
  246.  
  247. int FAR PASCAL PBORCA_LibraryEntryInformation ( HPBORCA           hORCASession,
  248.                                                 LPSTR             lpszLibName,  
  249.                                                 LPSTR             lpszEntryName, 
  250.                                                 PBORCA_TYPE       otEntryType,    
  251.                                                 PPBORCA_ENTRYINFO pEntryInfo );
  252.  
  253. int FAR PASCAL PBORCA_LibraryEntryMove ( HPBORCA     hORCASession,
  254.                                          LPSTR       lpszSourceLibName,  
  255.                                          LPSTR       lpszDestLibName,  
  256.                                          LPSTR       lpszEntryName, 
  257.                                          PBORCA_TYPE otEntryType );
  258.  
  259. /* *********************************************************************** */
  260. /* Compilation function prototypes                                         */
  261. /* *********************************************************************** */
  262.  
  263. int FAR PASCAL PBORCA_CompileEntryImport ( HPBORCA        hORCASession,
  264.                                            LPSTR          lpszLibraryName,  
  265.                                            LPSTR          lpszEntryName, 
  266.                                            PBORCA_TYPE    otEntryType, 
  267.                                            LPSTR          lpszComments,  
  268.                                            LPSTR          lpszEntrySyntax,
  269.                                            LONG           lEntrySyntaxBuffSize, 
  270.                                            PBORCA_ERRPROC pCompErrProc, 
  271.                                            LPVOID         pUserData );
  272.  
  273. int FAR PASCAL PBORCA_CompileEntryImportList ( HPBORCA          hORCASession,
  274.                                                LPSTR far       *pLibraryNames,  
  275.                                                LPSTR far       *pEntryNames, 
  276.                                                PBORCA_TYPE far *otEntryType, 
  277.                                                LPSTR far       *pComments,  
  278.                                                LPSTR far       *pEntrySyntaxBuffers,
  279.                                                LONG far        *pEntrySyntaxBuffSizes, 
  280.                                                int              iNumberOfEntries, 
  281.                                                PBORCA_ERRPROC   pCompErrProc, 
  282.                                                LPVOID           pUserData );
  283.  
  284. int FAR PASCAL PBORCA_CompileEntryRegenerate ( HPBORCA        hORCASession,
  285.                                                LPSTR          lpszLibraryName,  
  286.                                                LPSTR          lpszEntryName, 
  287.                                                PBORCA_TYPE    otEntryType, 
  288.                                                PBORCA_ERRPROC pCompErrProc, 
  289.                                                LPVOID         pUserData );
  290.  
  291. /* *********************************************************************** */
  292. /* Executable construction function prototypes                             */
  293. /* *********************************************************************** */
  294.  
  295. /* *********************************************************************** */
  296. /* Object query function prototypes                                        */
  297. /* *********************************************************************** */
  298.  
  299. int FAR PASCAL PBORCA_ObjectQueryHierarchy ( HPBORCA         hORCASession,
  300.                                              LPSTR           lpszLibraryName,  
  301.                                              LPSTR           lpszEntryName, 
  302.                                              PBORCA_TYPE     otEntryType, 
  303.                                              PBORCA_HIERPROC pHierarchyProc, 
  304.                                              LPVOID          pUserData );
  305.  
  306. int FAR PASCAL PBORCA_ObjectQueryReference ( HPBORCA         hORCASession,
  307.                                              LPSTR           lpszLibraryName,  
  308.                                              LPSTR           lpszEntryName, 
  309.                                              PBORCA_TYPE     otEntryType, 
  310.                                              PBORCA_REFPROC  pReferenceProc, 
  311.                                              LPVOID          pUserData );
  312.  
  313. #endif    /* PB_ORCA */
  314.  
  315.