parser.cpp

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
 */
 
#include <string>
#include <utility>
 
#include <catch2/catch_test_macros.hpp>
#include <catch2/matchers/catch_matchers_string.hpp>
 
#include "ast/program.hpp"
#include "lexer/modtoken.hpp"
#include "parser/diffeq_driver.hpp"
#include "parser/nmodl_driver.hpp"
#include "test/unit/utils/nmodl_constructs.hpp"
#include "test/unit/utils/test_utils.hpp"
#include "utils/common_utils.hpp"
#include "visitors/checkparent_visitor.hpp"
#include "visitors/visitor_utils.hpp"
 
 
using namespace nmodl::test_utils;
//=============================================================================
// Parser tests
//=============================================================================
 
bool is_valid_construct(const std::string& construct) {
    nmodl::parser::NmodlDriver driver;
    return driver.parse_string(construct) != nullptr;
}
 
 
SCENARIO("NMODL can accept CR as return char for one line comment", "[parser]") {
    GIVEN("A comment defined with CR as return char") {
        WHEN("parsing") {
            THEN("success") {
                REQUIRE(is_valid_construct(R"(: see you next line
PROCEDURE foo() {
                })"));
            }
        }
    }
}
 
SCENARIO("NMODL can define macros using DEFINE keyword", "[parser]") {
    GIVEN("A valid macro definition") {
        WHEN("DEFINE NSTEP 6") {
            THEN("parser accepts without an error") {
                REQUIRE(is_valid_construct("DEFINE NSTEP 6"));
            }
        }
        WHEN("DEFINE   NSTEP   6") {
            THEN("parser accepts without an error") {
                REQUIRE(is_valid_construct("DEFINE   NSTEP   6"));
            }
        }
    }
 
    GIVEN("A macro with nested definition is not supported") {
        WHEN("DEFINE SIX 6 DEFINE NSTEP SIX") {
            THEN("parser throws an error") {
                REQUIRE_THROWS_WITH(is_valid_construct("DEFINE SIX 6 DEFINE NSTEP SIX"),
                                    Catch::Matchers::ContainsSubstring("unexpected INVALID_TOKEN"));
            }
        }
    }
 
    GIVEN("A invalid macro definition with float value") {
        WHEN("DEFINE NSTEP 6.0") {
            THEN("parser throws an exception") {
                REQUIRE_THROWS_WITH(is_valid_construct("DEFINE NSTEP 6.0"),
                                    Catch::Matchers::ContainsSubstring("unexpected REAL"));
            }
        }
    }
 
    GIVEN("A invalid macro definition with name and without value") {
        WHEN("DEFINE NSTEP") {
            THEN("parser throws an exception") {
                REQUIRE_THROWS_WITH(is_valid_construct("DEFINE NSTEP"),
                                    Catch::Matchers::ContainsSubstring("expecting INTEGER"));
            }
        }
    }
 
    GIVEN("A invalid macro definition with name and value as a name") {
        WHEN("DEFINE NSTEP SIX") {
            THEN("parser throws an exception") {
                REQUIRE_THROWS_WITH(is_valid_construct("DEFINE NSTEP SIX"),
                                    Catch::Matchers::ContainsSubstring("expecting INTEGER"));
            }
        }
    }
 
    GIVEN("A invalid macro definition without name but with value") {
        WHEN("DEFINE 6") {
            THEN("parser throws an exception") {
                REQUIRE_THROWS_WITH(is_valid_construct("DEFINE 6"),
                                    Catch::Matchers::ContainsSubstring("expecting NAME"));
            }
        }
    }
}
 
SCENARIO("Macros can be used anywhere in the mod file") {
    std::string nmodl_text = R"(
            DEFINE NSTEP 6
            PARAMETER {
                amp[NSTEP] (mV)
            }
        )";
    WHEN("macro is used in parameter definition") {
        THEN("parser accepts without an error") {
            REQUIRE(is_valid_construct(nmodl_text));
        }
    }
}
 
SCENARIO("NMODL parser accepts empty unit specification") {
    std::string nmodl_text = R"(
            FUNCTION ssCB(kdf(), kds()) (mM) {
 
            }
        )";
    WHEN("FUNCTION is defined with empty unit") {
        THEN("parser accepts without an error") {
            REQUIRE(is_valid_construct(nmodl_text));
        }
    }
}
 
SCENARIO("NMODL parser running number of valid NMODL constructs") {
    for (const auto& construct: nmodl_valid_constructs) {
        auto test_case = construct.second;
        GIVEN(test_case.name) {
            THEN("Parser successfully parses : " + test_case.input) {
                REQUIRE(is_valid_construct(test_case.input));
            }
        }
    }
}
 
SCENARIO("NMODL parser running number of invalid NMODL constructs") {
    for (const auto& construct: nmodl_invalid_constructs) {
        auto test_case = construct.second;
        GIVEN(test_case.name) {
            THEN("Parser throws an exception while parsing : " + test_case.input) {
                REQUIRE_THROWS(is_valid_construct(test_case.input));
            }
        }
    }
}
 
//=============================================================================
// Ensure that the parser can handle invalid INCLUDE constructs
//=============================================================================
 
SCENARIO("Check that the parser doesn't crash when passing invalid INCLUDE constructs") {
    GIVEN("An empty filename") {
        REQUIRE_THROWS_WITH(is_valid_construct("INCLUDE \"\""),
                            Catch::Matchers::ContainsSubstring("empty filename"));
    }
 
    GIVEN("An missing included file") {
        REQUIRE_THROWS_WITH(is_valid_construct("INCLUDE \"unknown.file\""),
                            Catch::Matchers::ContainsSubstring(
                                "can not open file : \"unknown.file\""));
    }
 
    GIVEN("An invalid included file") {
        REQUIRE_THROWS_WITH(is_valid_construct("INCLUDE \"included.file\""),
                            Catch::Matchers::ContainsSubstring("unexpected End of file"));
    }
}
 
SCENARIO("NEURON block can add CURIE information", "[parser][represents]") {
    GIVEN("A valid CURIE information statement") {
        THEN("parser accepts without an error") {
            REQUIRE(is_valid_construct("NEURON { REPRESENTS NCIT:C17008 }"));
            REQUIRE(is_valid_construct("NEURON { REPRESENTS [NCIT:C17008] }"));
        }
    }
 
    GIVEN("Incomplete CURIE information statement") {
        THEN("parser throws an error") {
            REQUIRE_THROWS_WITH(is_valid_construct("NEURON { REPRESENTS }"),
                                Catch::Matchers::ContainsSubstring("Lexer Error"));
            REQUIRE_THROWS_WITH(is_valid_construct("NEURON { REPRESENTS NCIT}"),
                                Catch::Matchers::ContainsSubstring("Lexer Error"));
        }
    }
}
 
 
SCENARIO("Check parents in valid NMODL constructs") {
    nmodl::parser::NmodlDriver driver;
    for (const auto& construct: nmodl_valid_constructs) {
        // parse the string and get the ast
        const auto ast = driver.parse_string(construct.second.input);
        GIVEN(construct.second.name) {
            THEN("Check the parents in : " + construct.second.input) {
                // check the parents
                REQUIRE(!nmodl::visitor::test::CheckParentVisitor().check_ast(*ast));
            }
        }
    }
}
 
//=============================================================================
// Differential Equation Parser tests
//=============================================================================
 
std::string solve_construct(const std::string& equation, std::string method) {
    auto solution = nmodl::parser::DiffeqDriver::solve(equation, std::move(method));
    return solution;
}
 
SCENARIO("Legacy differential equation solver") {
    GIVEN("A differential equation") {
        int counter = 0;
        for (const auto& test_case: diff_eq_constructs) {
            auto prefix = "." + std::to_string(counter);
            WHEN(prefix + " EQUATION = " + test_case.equation + " METHOD = " + test_case.method) {
                THEN(prefix + " SOLUTION = " + test_case.solution) {
                    auto expected_result = test_case.solution;
                    auto result = solve_construct(test_case.equation, test_case.method);
                    REQUIRE(result == expected_result);
                }
            }
            counter++;
        }
    }
}
 
 
//=============================================================================
// Check if parsed NEURON block has correct token information
//=============================================================================
 
void parse_neuron_block_string(const std::string& name, nmodl::ModToken& value) {
    nmodl::parser::NmodlDriver driver;
    driver.parse_string(name);
 
    const auto& ast_program = driver.get_ast();
    const auto& neuron_blocks = nmodl::collect_nodes(*ast_program->get_shared_ptr(),
                                                     {nmodl::ast::AstNodeType::NEURON_BLOCK});
    value = *(neuron_blocks.front()->get_token());
}
 
SCENARIO("Check if a NEURON block is parsed with correct location info in its token") {
    GIVEN("A single NEURON block") {
        nmodl::ModToken value;
 
        std::stringstream ss;
        std::string neuron_block = R"(
        NEURON {
            SUFFIX it
            USEION ca READ cai,cao WRITE ica
            RANGE gcabar, m_inf, tau_m, alph1, alph2, KK, shift
        }
        )";
        parse_neuron_block_string(reindent_text(neuron_block), value);
        ss << value;
        REQUIRE(ss.str() == "         NEURON at [1.1-5.1] type 296");
    }
}