Return to freem.h CVS log

Up to [Coherent Logic Development] / freem / src

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

1.1       snw         1: /*
1.4     ! snw         2:  *   $Id: freem.h,v 1.3 2025/03/09 19:14:25 snw Exp $
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.4     ! snw        28:  *   $Log: freem.h,v $
        !            29:  *   Revision 1.3  2025/03/09 19:14:25  snw
        !            30:  *   First phase of REUSE compliance and header reformat
        !            31:  *
1.3       snw        32:  *
                     33:  * SPDX-FileCopyrightText:  (C) 2025 Coherent Logic Development LLC
                     34:  * SPDX-License-Identifier: AGPL-3.0-or-later 
1.1       snw        35:  **/
                     36: 
                     37: #ifndef _LIBFREEM_H
                     38: # define _LIBFREEM_H
                     39: 
                     40: #include "merr.h"
                     41: #include <sys/types.h>
                     42: 
                     43: #if !defined(STRLEN)
1.4     ! snw        44: # define STRLEN 255
        !            45: #endif
        !            46: 
        !            47: #if !defined(BIGSTR)
        !            48: # define BIGSTR 65535
1.1       snw        49: #endif
                     50: 
                     51: #define MREF_RT_LOCAL 0
                     52: #define MREF_RT_GLOBAL 1
                     53: #define MREF_RT_SSVN 2
                     54: #define MREF_RT_SSV MREF_RT_SSVN
                     55: 
                     56: #define MREF_ST_NEW 0
                     57: #define MREF_ST_INIT 1
                     58: #define MREF_ST_ERR 10
                     59: 
                     60: #define MLIB_ERRLEN 180
                     61: 
                     62: typedef struct freem_ref_t {
                     63: 
                     64:     /*
                     65:      * The 'reftype' field can be one of:
                     66:      * 
                     67:      *  MREF_RT_LOCAL
                     68:      *  MREF_RT_GLOBAL
                     69:      *  MREF_RT_SSVN
                     70:      */
                     71:     short reftype;
                     72: 
                     73:     /*
                     74:      * The 'name' field is the name of the local variable,
                     75:      * global variable, or SSV.
                     76:      */
1.4     ! snw        77:     char name[STRLEN];    
1.1       snw        78: 
                     79:     /*
                     80:      * Returned data goes in a string, so it is important to make sure
                     81:      * that your application accounts for canonical numbers as needed.
                     82:      */
                     83:     char value[STRLEN];   
                     84: 
                     85:     short status;
                     86: 
                     87:     unsigned int subscript_count;
1.4     ! snw        88:     char subscripts[255][STRLEN];
1.1       snw        89: 
                     90: } freem_ref_t;
                     91: 
                     92: typedef struct freem_ent_t {
                     93: 
                     94:     /* name of function or procedure entry point */
                     95:     char name[256];
                     96: 
                     97:     /* return value */
                     98:     char value[STRLEN];
                     99: 
                    100:     /* value of ierr on return */
                    101:     short status;
                    102: 
                    103:     /* argument count and array */
                    104:     unsigned int argument_count;
                    105:     char arguments[255][256];
                    106: 
                    107: } freem_ent_t;
                    108: 
                    109: #ifndef TRUE
                    110: # define TRUE 1
                    111: #endif
                    112: 
                    113: #ifndef FALSE
                    114: # define FALSE 0
                    115: #endif
                    116: 
                    117: #ifdef __cplusplus
                    118:  extern "C" {
                    119: #endif
                    120: 
                    121: extern pid_t freem_init(char *environment_name, char *namespace_name);
                    122: extern short freem_version(char *result);
                    123: extern short freem_set(freem_ref_t *ref);
                    124: extern short freem_get(freem_ref_t *ref);
                    125: extern short freem_kill(freem_ref_t *ref);
                    126: extern short freem_data(freem_ref_t *ref);
                    127: extern short freem_order(freem_ref_t *ref);
                    128: extern short freem_query(freem_ref_t *ref);
                    129: extern short freem_lock(freem_ref_t *ref, long lck_timeout);
                    130: extern short freem_unlock(freem_ref_t *ref, long lck_timeout);
                    131: extern short freem_tstart(char *tp_id, short serial, short restartable, char **sym_save);
                    132: extern short freem_trestart(void);
                    133: extern short freem_trollback(int tp_levels);
                    134: extern short freem_tcommit(void);
                    135: extern int freem_tlevel(void);
                    136: extern short freem_function(freem_ent_t *ent);
                    137: extern short freem_procedure(freem_ent_t *ent);
                    138: extern short freem_errmsg(int code, char *msg);
                    139:      
                    140: #ifdef __cplusplus
                    141:  }
                    142: #endif
                    143: 
                    144: #endif