preprocess.h

/*
 * Basic preprocessor for Spin
 *
 * Written by Eric R. Smith
 * Copyright (c) 2012-2022 Total Spectrum Software Inc.
 * MIT Licensed; see preprocess.c for details
 */

#ifndef PREPROCESS_H_
#define PREPROCESS_H_

#include <string.h>
#include "util/flexbuf.h"

struct predef {
    struct predef *next;
    const char *name;
    const char *def;
    const char *argcdef; /* -Dname=def version, for passing to mcpp */
    int  flags;
};
#define PREDEF_FLAG_FREEDEFS 0x01  /* if "name" and "def" should be freed */


#define MODE_UNKNOWN 0
#define MODE_UTF8    1
#define MODE_UTF16   2

struct filestate {
    struct filestate *next;
    FILE *f;
    const char *name;
    int lineno;
    int (*readfunc)(FILE *f, char *buf);
    int flags;
    int skipnl;
};
#define FILE_FLAGS_CLOSEFILE 0x01

struct ifstate {
    struct ifstate *next;
    struct filestate *fil; /* for the current file */
    int skip;      /* if we are currently skipping code */
    int linenum;   /* the line number it started on */
    int skiprest;  /* if we have already processed some branch */
    int sawelse;  /* if we have already processed a #else */
};

struct preprocess {
    struct filestate *fil;
    struct flexbuf line;
    struct flexbuf whole;
    struct predef *defs;

    struct ifstate *ifs;

    /* comment handling code */
    const char *linecomment;
    const char *startcomment;
    const char *endcomment;

    int incomment;
    int special_flexspin_comment;
    
    /* error handling code */
    void (*errfunc)(void *arg, const char *filename, int linenum, const char *msg);
    void (*warnfunc)(void *arg, const char *filename, int linenum, const char *msg);
    void *errarg;
    void *warnarg;

    int  numwarnings;
    int  numerrors;

    int  in_error; /* flag to help the default error handling function */

    /* printf format for the line emitted when a #include causes
       line number or file to be different
    */
    const char *linechange;

    /* list of strings to use as an include path */
    struct flexbuf inc_path;

    /* if 1, preprocessor should ignore case */
    /* default is 0 (for compatiblity) where case matters in macros and #ifdef */
    int ignore_case;
};

#define pp_active(pp) (!((pp)->ifs && (pp)->ifs->skip))

/* initialize for reading */
void pp_init(struct preprocess *pp);

/* push an opened FILE struct */
void pp_push_file_struct(struct preprocess *pp, FILE *f, const char *name);

/* push a file by name */
void pp_push_file(struct preprocess *pp, const char *filename);

/* pop a file (finish processing it) */
void pp_pop_file(struct preprocess *pp);

/* set the strings that will be recognized to start single line comments
   (line) and start and end multi-line comments (s and n); the multi-line
   comments nest */
void pp_setcomments(struct preprocess *pp, const char *line, const char *s, const char *e);

/* set the format for #line directives indicating changes of file or line
   number; the default is "#line %d \"%s\"
*/
void pp_setlinedirective(struct preprocess *pp, const char *s);

/* define symbol "name" to have "val", or undefine it if val is NULL */
void pp_define(struct preprocess *pp, const char *name, const char *val);

/* like pp_define, but puts the definition at the end of the defines (so it should remain visible) */
void pp_define_weak_global(struct preprocess *pp, const char *name, const char *val);

/* get the current state of the define stack */
void *pp_get_define_state(struct preprocess *pp);

/* restore the define state to the state given by a previous call to get_define_state */
void pp_restore_define_state(struct preprocess *pp, void *ptr);

/* actually perform the preprocessing on all files that have been pushed so far */
void pp_run(struct preprocess *pp);

/* finish preprocessing and retrieve the result string */
char *pp_finish(struct preprocess *pp);

/* find a file on the standard include path */
/* "ext" is an optional extension which may be applied to the file */
/* "relativeto" is an optional name that the file's path may be relative to */
/* returns the full name */
char *find_file_on_path(struct preprocess *pp, const char *name, const char *ext, const char *relativeto);

void pp_add_to_path(struct preprocess *pp, const char *dir);

/* fill argv[] starting at argc,
 * with -Ipath for all paths in pp,
 * and -Dname=def for all defines in pp
 * returns updated argc
 */
int pp_get_defines_as_args(struct preprocess *pp, int argc, char **argv, int max_argc);

extern struct preprocess gl_pp;

#endif