vkd3d/libs/vkd3d-shader/preproc.h

/*
 * HLSL preprocessor
 *
 * Copyright 2020 Zebediah Figura for CodeWeavers
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 */

#ifndef __VKD3D_SHADER_PREPROC_H
#define __VKD3D_SHADER_PREPROC_H

#include "vkd3d_shader_private.h"
#include "rbtree.h"

struct preproc_if_state
{
    /* Are we currently in a "true" block? */
    bool current_true;
    /* Have we seen a "true" block in this #if..#endif yet? */
    bool seen_true;
    /* Have we seen an #else yet? */
    bool seen_else;
};

struct preproc_buffer
{
    void *lexer_buffer;
    struct vkd3d_shader_location location;
};

struct preproc_file
{
    struct preproc_buffer buffer;
    struct vkd3d_shader_code code;
    char *filename;

    struct preproc_if_state *if_stack;
    size_t if_count, if_stack_size;
};

struct preproc_text
{
    struct vkd3d_string_buffer text;
    struct vkd3d_shader_location location;
};

struct preproc_expansion
{
    struct preproc_buffer buffer;
    const struct preproc_text *text;
    /* Back-pointer to the macro, if this expansion a macro body. This is
     * necessary so that argument tokens can be correctly replaced. */
    struct preproc_macro *macro;
};

struct preproc_macro
{
    struct rb_entry entry;
    char *name;

    char **arg_names;
    size_t arg_count;
    struct preproc_text *arg_values;

    struct preproc_text body;
};

struct preproc_ctx
{
    const struct vkd3d_shader_preprocess_info *preprocess_info;
    void *scanner;

    struct vkd3d_shader_message_context *message_context;
    struct vkd3d_string_buffer buffer;

    struct preproc_file *file_stack;
    size_t file_count, file_stack_size;

    struct preproc_expansion *expansion_stack;
    size_t expansion_count, expansion_stack_size;

    struct rb_tree macros;

    /* It's possible to parse as many as two function-like macros at once: one
     * in the main text, and another inside of #if directives. E.g.
     *
     * func1(
     * #if func2(...)
     * #endif
     * )
     *
     * It's not possible to parse more than two, however. In the case of nested
     * calls like "func1(func2(...))", we store everything inside the outer
     * parentheses as unparsed text, and then parse it once the argument is
     * actually invoked.
     */
    struct preproc_func_state
    {
        struct preproc_macro *macro;
        size_t arg_count;
        enum
        {
            STATE_NONE = 0,
            STATE_IDENTIFIER,
            STATE_ARGS,
        } state;
        unsigned int paren_depth;
    } text_func, directive_func;

    int current_directive;

    int lookahead_token;

    bool last_was_newline;
    bool last_was_eof;
    bool last_was_defined;

    bool error;
};

bool preproc_add_macro(struct preproc_ctx *ctx, const struct vkd3d_shader_location *loc, char *name, char **arg_names,
        size_t arg_count, const struct vkd3d_shader_location *body_loc, struct vkd3d_string_buffer *body);
void preproc_close_include(struct preproc_ctx *ctx, const struct vkd3d_shader_code *code);
struct preproc_macro *preproc_find_macro(struct preproc_ctx *ctx, const char *name);
void preproc_free_macro(struct preproc_macro *macro);
bool preproc_push_include(struct preproc_ctx *ctx, char *filename, const struct vkd3d_shader_code *code);
void preproc_warning(struct preproc_ctx *ctx, const struct vkd3d_shader_location *loc,
        enum vkd3d_shader_error error, const char *format, ...) VKD3D_PRINTF_FUNC(4, 5);

static inline struct preproc_file *preproc_get_top_file(struct preproc_ctx *ctx)
{
    assert(ctx->file_count);
    return &ctx->file_stack[ctx->file_count - 1];
}

#endif