Return to freem.h CVS log

Up to [Coherent Logic Development] / freem / src

Annotation of freem/src/freem.h, revision 1.3

1.1       snw         1: /*
1.3     ! snw         2:  *   $Id$
1.1       snw         3:  *    libfreem data structures and prototypes
                      4:  * 
                      5:  *    NOTE: Caller must pre-allocate memory for *all* APIs!
                      6:  *
                      7:  *  
1.2       snw         8:  *   Author: Serena Willis <snw@coherent-logic.com>
1.1       snw         9:  *    Copyright (C) 1998 MUG Deutschland
1.3     ! snw        10:  *    Copyright (C) 2020, 2025 Coherent Logic Development LLC
1.1       snw        11:  *
                     12:  *
                     13:  *   This file is part of FreeM.
                     14:  *
                     15:  *   FreeM is free software: you can redistribute it and/or modify
                     16:  *   it under the terms of the GNU Affero Public License as published by
                     17:  *   the Free Software Foundation, either version 3 of the License, or
                     18:  *   (at your option) any later version.
                     19:  *
                     20:  *   FreeM is distributed in the hope that it will be useful,
                     21:  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
                     22:  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     23:  *   GNU Affero Public License for more details.
                     24:  *
                     25:  *   You should have received a copy of the GNU Affero Public License
                     26:  *   along with FreeM.  If not, see <https://www.gnu.org/licenses/>.
                     27:  *
1.3     ! snw        28:  *   $Log$
        !            29:  *
        !            30:  * SPDX-FileCopyrightText:  (C) 2025 Coherent Logic Development LLC
        !            31:  * SPDX-License-Identifier: AGPL-3.0-or-later 
1.1       snw        32:  **/
                     33: 
                     34: #ifndef _LIBFREEM_H
                     35: # define _LIBFREEM_H
                     36: 
                     37: #include "merr.h"
                     38: #include <sys/types.h>
                     39: 
                     40: #if !defined(STRLEN)
                     41: # define STRLEN 65535
                     42: #endif
                     43: 
                     44: #define MREF_RT_LOCAL 0
                     45: #define MREF_RT_GLOBAL 1
                     46: #define MREF_RT_SSVN 2
                     47: #define MREF_RT_SSV MREF_RT_SSVN
                     48: 
                     49: #define MREF_ST_NEW 0
                     50: #define MREF_ST_INIT 1
                     51: #define MREF_ST_ERR 10
                     52: 
                     53: #define MLIB_ERRLEN 180
                     54: 
                     55: typedef struct freem_ref_t {
                     56: 
                     57:     /*
                     58:      * The 'reftype' field can be one of:
                     59:      * 
                     60:      *  MREF_RT_LOCAL
                     61:      *  MREF_RT_GLOBAL
                     62:      *  MREF_RT_SSVN
                     63:      */
                     64:     short reftype;
                     65: 
                     66:     /*
                     67:      * The 'name' field is the name of the local variable,
                     68:      * global variable, or SSV.
                     69:      */
                     70:     char name[256];    
                     71: 
                     72:     /*
                     73:      * Returned data goes in a string, so it is important to make sure
                     74:      * that your application accounts for canonical numbers as needed.
                     75:      */
                     76:     char value[STRLEN];   
                     77: 
                     78:     short status;
                     79: 
                     80:     unsigned int subscript_count;
                     81:     char subscripts[255][256];
                     82: 
                     83: } freem_ref_t;
                     84: 
                     85: typedef struct freem_ent_t {
                     86: 
                     87:     /* name of function or procedure entry point */
                     88:     char name[256];
                     89: 
                     90:     /* return value */
                     91:     char value[STRLEN];
                     92: 
                     93:     /* value of ierr on return */
                     94:     short status;
                     95: 
                     96:     /* argument count and array */
                     97:     unsigned int argument_count;
                     98:     char arguments[255][256];
                     99: 
                    100: } freem_ent_t;
                    101: 
                    102: #ifndef TRUE
                    103: # define TRUE 1
                    104: #endif
                    105: 
                    106: #ifndef FALSE
                    107: # define FALSE 0
                    108: #endif
                    109: 
                    110: #ifdef __cplusplus
                    111:  extern "C" {
                    112: #endif
                    113: 
                    114: extern pid_t freem_init(char *environment_name, char *namespace_name);
                    115: extern short freem_version(char *result);
                    116: extern short freem_set(freem_ref_t *ref);
                    117: extern short freem_get(freem_ref_t *ref);
                    118: extern short freem_kill(freem_ref_t *ref);
                    119: extern short freem_data(freem_ref_t *ref);
                    120: extern short freem_order(freem_ref_t *ref);
                    121: extern short freem_query(freem_ref_t *ref);
                    122: extern short freem_lock(freem_ref_t *ref, long lck_timeout);
                    123: extern short freem_unlock(freem_ref_t *ref, long lck_timeout);
                    124: extern short freem_tstart(char *tp_id, short serial, short restartable, char **sym_save);
                    125: extern short freem_trestart(void);
                    126: extern short freem_trollback(int tp_levels);
                    127: extern short freem_tcommit(void);
                    128: extern int freem_tlevel(void);
                    129: extern short freem_function(freem_ent_t *ent);
                    130: extern short freem_procedure(freem_ent_t *ent);
                    131: extern short freem_errmsg(int code, char *msg);
                    132:      
                    133: #ifdef __cplusplus
                    134:  }
                    135: #endif
                    136: 
                    137: #endif