verbatim_var_rename_visitor.hpp

Go to the documentation of this file.

/*
 * Copyright 2023 Blue Brain Project, EPFL.
 * See the top-level LICENSE file for details.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#pragma once
 
/**
 * \file
 * \brief \copybrief nmodl::visitor::VerbatimVarRenameVisitor
 */
 
#include <stack>
#include <string>
 
#include "symtab/symbol_table.hpp"
#include "visitors/ast_visitor.hpp"
 
namespace nmodl {
namespace visitor {
 
/**
 * @addtogroup visitor_classes
 * @{
 */
 
/**
 * \class VerbatimVarRenameVisitor
 * \brief Rename variable in verbatim block
 *
 * Verbatim blocks in NMODL use different names for local
 * and range variables:
 *  - if local variable is `xx` then translated name of variable
 *    in C file is `_lxx`
 *  - if range (or any other global) variable is `xx` then translated
 *    name of the variable is `_p_xx`
 *
 * This naming convention is based on NEURON code generation convention.
 * As part of this pass, we revert such usages of the variable to original
 * names. We do this only if variable is present in symbol table.
 *
 * \todo Check if symbol table lookup is ok or there are cases where this
 *       could be error prone.
 */
class VerbatimVarRenameVisitor: public AstVisitor {
  private:
    /// non-null symbol table in the scope hierarchy
    symtab::SymbolTable* symtab = nullptr;
 
    /// symbol tables in nested blocks
    std::stack<symtab::SymbolTable*> symtab_stack;
 
    /// prefix used for local variable
    const std::string LOCAL_PREFIX = "_l";
 
    /// prefix used for range variables
    const std::string RANGE_PREFIX = "_p_";
 
    /// prefix used for range variables
    const std::string ION_PREFIX = "_ion_";
 
    std::string rename_variable(const std::string& name);
 
  public:
    VerbatimVarRenameVisitor() = default;
 
    void visit_verbatim(ast::Verbatim& node) override;
    void visit_statement_block(ast::StatementBlock& node) override;
};
 
/** @} */  // end of visitor_classes
 
}  // namespace visitor
}  // namespace nmodl