ReactionExpression.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
//
// Copyright 2026 Caleb Buahin
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

 
#ifndef OPENSWMM_ENGINE_TRANSPORT_REACTION_EXPRESSION_HPP
#define OPENSWMM_ENGINE_TRANSPORT_REACTION_EXPRESSION_HPP
 
#include <string>
#include <vector>
 
#include "../../../data/ReactionTokens.hpp"
 
namespace openswmm {
struct ReactionData;
}
namespace openswmm::transport {

std::string reactionContextDiagnostic(const ReactionData&, const std::vector<RxToken>&,
                                      const RxExprSpan&, int context);
 
using openswmm::RxToken;
using openswmm::RxExprSpan;
using openswmm::RxHydVar;
using openswmm::kRxMaxStackDepth;

struct RxSymbols {
    const std::vector<std::string>* species = nullptr; 
    const std::vector<std::string>* coefs = nullptr;
    const std::vector<std::string>* terms = nullptr; 
    const std::vector<std::string>* pollutants = nullptr;
    int max_term = 0; 
};

struct RxEvalEnv {
    const double* species = nullptr;    
    const double* coefs = nullptr;      
    const double* terms = nullptr;      
    const double* hydvar = nullptr;     
    const double* pollutants = nullptr; 
};

std::string compileReactionExpression(const std::string& src, const RxSymbols& symbols,
                                      std::vector<RxToken>& pool, RxExprSpan& out, int& error_col);
 
// ---------------------------------------------------------------------------
// Vocabulary discovery (E-C1) — served from the compiler's OWN tables so the
// GUI completer/highlighter (swmm_reaction_hydvar_* / swmm_reaction_
// function_*) cannot drift from what actually compiles. Returned pointers
// are static storage.
// ---------------------------------------------------------------------------

int reactionFunctionCount();
bool reactionFunctionInfo(int idx, const char** name, int* arity);
int reactionHydVarCount();
bool reactionHydVarInfo(int idx, const char** name, const char** description);

bool reactionHydVarPopulated(int idx);

std::string unpopulatedHydVarDiagnostic(const std::string& src, const std::vector<RxToken>& pool,
                                        const RxExprSpan& span, int& error_col);

double evalReactionExpression(const std::vector<RxToken>& pool, const RxExprSpan& span,
                              const RxEvalEnv& env) noexcept;
 
} // namespace openswmm::transport
 
#endif // OPENSWMM_ENGINE_TRANSPORT_REACTION_EXPRESSION_HPP