preproc.h

#ifndef PREPROC_H
#define PREPROC_H

#include "compiler.h"
#include "diagnostics.h"
#include "fs.h"
#include "program.h"

#include <stdio.h>

enum preproc_create_result { PREPROC_CREATE_RESULT_SUCCESS = 0 };

struct preproc;

struct preproc_define_macro {
  ustr_t name;
  ustr_t value;
};

struct preproc_create_args {
  bool verbose;

  enum compile_target target;
  enum compile_c_standard c_standard;
  const char *path;

  size_t num_defines;
  struct preproc_define_macro *defines;

  size_t num_sys_include_paths;
  const char **sys_include_paths;

  size_t num_include_paths;
  char **include_paths;

  // for debugging: fixes the value of __TIME__ and __DATE__
  const char *fixed_timestamp;
};

enum preproc_create_result
preproc_create(struct program program, struct fs *fs,
               struct preproc_create_args args,
               struct compiler_diagnostics *diagnostics,
               enum compile_preproc_mode mode, struct preproc **preproc);

struct preprocessed_program {
  const char *text;

  const struct preproc_token *tokens;
  size_t num_tokens;
};

enum preproc_token_ty {
  PREPROC_TOKEN_TY_UNKNOWN,
  PREPROC_TOKEN_TY_EOF,

  PREPROC_TOKEN_TY_DIRECTIVE,
  PREPROC_TOKEN_TY_IDENTIFIER,
  PREPROC_TOKEN_TY_PREPROC_NUMBER,
  PREPROC_TOKEN_TY_STRING_LITERAL,
  PREPROC_TOKEN_TY_PUNCTUATOR,
  PREPROC_TOKEN_TY_NEWLINE,
  PREPROC_TOKEN_TY_WHITESPACE,
  PREPROC_TOKEN_TY_COMMENT,
  PREPROC_TOKEN_TY_OTHER,
};

enum preproc_token_punctuator_ty {
  PREPROC_TOKEN_PUNCTUATOR_TY_OPEN_BRACKET,         // (
  PREPROC_TOKEN_PUNCTUATOR_TY_CLOSE_BRACKET,        // )
  PREPROC_TOKEN_PUNCTUATOR_TY_OPEN_BRACE,           // {
  PREPROC_TOKEN_PUNCTUATOR_TY_CLOSE_BRACE,          // }
  PREPROC_TOKEN_PUNCTUATOR_TY_OPEN_SQUARE_BRACKET,  // [
  PREPROC_TOKEN_PUNCTUATOR_TY_CLOSE_SQUARE_BRACKET, // ]

  PREPROC_TOKEN_PUNCTUATOR_TY_COLON,     // :
  PREPROC_TOKEN_PUNCTUATOR_TY_SEMICOLON, // ;
  PREPROC_TOKEN_PUNCTUATOR_TY_COMMA,     // ,
  PREPROC_TOKEN_PUNCTUATOR_TY_DOT,       // .
  PREPROC_TOKEN_PUNCTUATOR_TY_ARROW,     // ->
  PREPROC_TOKEN_PUNCTUATOR_TY_QMARK,     // ?

  /* Operators */

  PREPROC_TOKEN_PUNCTUATOR_TY_OP_LOGICAL_NOT, // !
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_NOT,         // ~

  PREPROC_TOKEN_PUNCTUATOR_TY_OP_INC, // ++
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_DEC, // --

  PREPROC_TOKEN_PUNCTUATOR_TY_OP_LOGICAL_AND, // &&
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_LOGICAL_OR,  // ||
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_AND,         // &
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_AND_ASSG,    // &=
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_OR,          // |
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_OR_ASSG,     // |=
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_XOR,         // ^
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_XOR_ASSG,    // ^=
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_RSHIFT,      // >>
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_RSHIFT_ASSG, // >>=
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_LSHIFT,      // <<
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_LSHIFT_ASSG, // <<=
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_ADD,         // +
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_ADD_ASSG,    // +=
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_SUB,         // -
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_SUB_ASSG,    // -=
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_MUL,         // *
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_MUL_ASSG,    // *=
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_DIV,         // /
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_DIV_ASSG,    // /=
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_MOD,         // %
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_MOD_ASSG,    // %=

  PREPROC_TOKEN_PUNCTUATOR_TY_OP_ASSG, // =

  PREPROC_TOKEN_PUNCTUATOR_TY_OP_EQ,   // ==
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_NEQ,  // !=
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_LT,   // <
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_LTEQ, // <=
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_GT,   // >
  PREPROC_TOKEN_PUNCTUATOR_TY_OP_GTEQ, // >=

  /* Variadic */

  PREPROC_TOKEN_PUNCTUATOR_TY_ELLIPSIS,

  /* Preprocessor specific */

  PREPROC_TOKEN_PUNCTUATOR_TY_STRINGIFY, // #
  PREPROC_TOKEN_PUNCTUATOR_TY_CONCAT,    // ##
};

struct preproc_token_punctuator {
  enum preproc_token_punctuator_ty ty;
};

enum FLAG_ENUM preproc_token_flags {
  PREPROC_TOKEN_FLAG_NONE = 0,
  PREPROC_TOKEN_FLAG_MACRO_EXPANSION = 1 << 0,
};

struct preproc_token {
  enum preproc_token_ty ty;

  ustr_t text;
  struct text_span span;

  union {
    struct preproc_token_punctuator punctuator;
  };

  enum preproc_token_flags flags;
};

struct preproc_event_include {
  const char *path;
};

struct preproc_event_macro_expand {
  struct text_span span;
};

enum preproc_event_ty {
  PREPROC_EVENT_TY_INCLUDE,
  PREPROC_EVENT_TY_MACRO_EXPAND,
};

struct preproc_event {
  enum preproc_event_ty ty;

  struct text_span span;

  union {
    struct preproc_event_include include;
    struct preproc_event_macro_expand macro_expand;
  };
};

struct preproc_events {
  struct preproc_event *events;
  size_t num_events;
};

enum FLAG_ENUM preproc_expand_token_flags {
  PREPROC_EXPAND_TOKEN_FLAG_NONE = 0,

  // expand undef tokens to zero (used by #if/#elif)
  PREPROC_EXPAND_TOKEN_FLAG_UNDEF_ZERO = 1 << 0,
};

void preproc_next_token(struct preproc *preproc, struct preproc_token *token,
                        enum preproc_expand_token_flags flags);

void preproc_next_raw_token(struct preproc *preproc,
                            struct preproc_token *token);

struct preproc_events preproc_get_events(struct preproc *preproc);

void preproc_process(struct preproc *preproc, FILE *file);

void preproc_free(struct preproc **preproc);

#endif