parser.h

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) BDSIM Collaboration, 2001 - 2026.
 
This file is part of BDSIM.
 
BDSIM is free software: you can redistribute it and/or modify 
it under the terms of the GNU General Public License as published 
by the Free Software Foundation version 3 of the License.
 
BDSIM 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 General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with BDSIM.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef PARSER_H
#define PARSER_H
 
#include <list>
#include <map>
#include <set>
#include <string>
#include <vector>
 
#include "aperture.h"
#include "atom.h"
#include "beam.h"
#include "blmplacement.h"
#include "cavitymodel.h"
#include "newcolour.h"
#include "coolingchannel.h"
#include "crystal.h"
#include "element.h"
#include "elementtype.h"
#include "field.h"
#include "fastlist.h"
#include "laser.h"
#include "material.h"
#include "modulator.h"
#include "options.h"
#include "parameters.h"
#include "physicsbiasing.h"
#include "placement.h"
#include "query.h"
#include "region.h"
#include "scorer.h"
#include "scorermesh.h"
#include "samplerplacement.h"
#include "symbolmap.h"
#include "tunnel.h"
 
int yyerror(const char *);
int yyerror2(const char *s); 
extern int yylex();
 
namespace GMAD
{
  class Array;
  class Symtab;
  class Parser
  {
  public:
 
    static Parser* Instance(const std::string& filename);
    static Parser* Instance();
    virtual ~Parser();
    Parser();
 
  protected:
    explicit Parser(std::string filename);
 
  private:
    static Parser* instance;
    void Initialise();
    void ParseFile(FILE *f);
 
  public:
    void quit();
    void write_table(std::string* name, ElementType type, bool isLine=false);
 
    void expand_sequences();
    void expand_line(FastList<Element>& target,
                     const std::string& name,
                     const std::string& start = "",
                     const std::string& end   = "");
 
    void expand_line(const std::string& name,
                     const std::string& start,
                     const std::string& end);
 
    std::vector<std::string>& get_sequences();
 
    const FastList<Element>& get_sequence(const std::string& name, bool bExit = true);
 
    int add_sampler_partIDSet(std::list<int>* samplerPartIDListIn);
    void add_sampler(const std::string& name, int count, ElementType type, std::string samplerType, std::list<int>* samplerPartIDListIn = nullptr);
    template <class C, class Container=FastList<C>>
    void Add();
    template <class C, class Container=FastList<C>>
    void Add(bool unique, const std::string& className);
    template <class C>
    C& GetGlobal();
    template <class C>
    C* GetGlobalPtr();
    template <class C, class Container=FastList<C>>
    Container& GetList();
 
    const std::set<std::set<int>>& GetSamplerFilters() const {return samplerFilters;}
    const std::map<int, std::set<int>>& GetSamplerFilterIDToSet() const {return samplerFilterIDToSet;}
 
    Element& find_element(const std::string& element_name);
    const Element& find_element(const std::string& element_name) const;
    const Element* find_element_safe(const std::string& element_name) const;
    const Element* find_placement_element_safe(const std::string& element_name) const;
    double property_lookup(const std::string& element_name, const std::string& property_name) const;
    void add_element_temp(const std::string& name, int number, bool pushfront, ElementType linetype);
    int copy_element_to_params(const std::string& elementName);
 
    bool InvalidSymbolName(const std::string& s, std::string& errorReason);
    Symtab * symcreate(const std::string& s);
    Symtab * symlook(const std::string& s);
 
    void Store(double value);
    void Store(const std::string& name);
    void FillArray(Array*);
    void FillString(Array*);
    void ClearParams();
    template <class C, typename T>
    void SetValue(std::string property, T value);
    template <class C>
    double GetValue(std::string property);
 
    template<typename T>
    std::list<T>* ArrayToList(Array*);
 
    template <typename T>
    void ExtendValue(const std::string& property, T value);
 
    void Overwrite(const std::string& objectName);
    void AddVariable(std::string* name);
    void PrintBeamline()const;
    void PrintElements()const;
    void PrintOptions()const;
    bool TryPrintingObject(const std::string& objectName) const;
 
    std::string current_line;
    std::string current_start;
    std::string current_end;
    const FastList<Element>& GetBeamline() const;
 
    std::string GetCallSequenceLog();
  private:
    void set_sampler(const std::string& name,
                     int count, ElementType type,
                     const std::string& samplerType,
                     double samplerRadius=0,
                     int particleSetID = -1);
    void add_func(std::string name, double (*func)(double));
    void add_var(std::string name, double value, int is_reserved = 0);
 
    // protected implementation (for inheritance to BDSParser - hackish)
  protected:
    Beam beam;
    Options options;
    FastList<Element>   beamline_list;
    FastList<Atom>   atom_list;
    FastList<NewColour> colour_list;
    FastList<Crystal> crystal_list;
    FastList<CoolingChannel> coolingchannel_list;
    FastList<Field>  field_list;
    FastList<Material> material_list;
    FastList<Query> query_list;
    FastList<Region> region_list;
    FastList<Tunnel> tunnel_list;
    FastList<PhysicsBiasing> xsecbias_list;
    FastList<Placement> placement_list;
    FastList<Laser> laser_list;
    FastList<CavityModel> cavitymodel_list;
    FastList<SamplerPlacement> samplerplacement_list;
    FastList<Scorer> scorer_list;
    FastList<ScorerMesh> scorermesh_list;
    FastList<Aperture> aperture_list;
    FastList<BLMPlacement> blm_list;
    FastList<Modulator> modulator_list;
 
  private:
    // *****************
    // Private members *
    // *****************
    const int MAX_EXPAND_ITERATIONS = 50;
 
    std::list<double> tmparray;
    std::list<std::string> tmpstring;
    std::vector<std::list<Element>*> allocated_lines;
 
    Parameters params;
    Atom atom;
    NewColour colour;
    Crystal crystal;
    CoolingChannel coolingchannel;
    Field field;
    Laser laser;
    Material material;
    PhysicsBiasing xsecbias;
    Placement placement;
    Query query;
    Region region;
    Tunnel tunnel;
    CavityModel cavitymodel;
    SamplerPlacement samplerplacement;
    Scorer scorer;
    ScorerMesh scorermesh;
    Aperture aperture;
    BLMPlacement blm;
    Modulator modulator;
 
    template <class C>
    bool FindAndExtend(const std::string& objectName);
    template <class C>
    void ExtendObject(C& object);
 
    std::map<std::string, double> extendedNumbers;
    std::map<std::string, std::string> extendedStrings;
    std::map<std::string, Array*> extendedVectors;
 
    FastList<Element> element_list;
    
    FastList<Element> placement_elements;
 
    std::list<Element> tmp_list;
    
    std::vector<std::string> sequences;
 
    std::map<std::string, FastList<Element>*> expandedSequences;
 
    SymbolMap symtab_map;
    std::vector<std::string*> var_list;
 
    std::set<std::set<int>> samplerFilters;
    std::map<int, std::set<int>> samplerFilterIDToSet;
    std::map<std::set<int>, int> setToSamplerFilterID;
 
    std::stringstream *call_sequence_log = new std::stringstream();
  };
 
  template <class C, typename T>
  void Parser::SetValue(std::string property, T value)
  {
    GetGlobal<C>().set_value(property, value);
  }
 
  template <class C>
  double Parser::GetValue(std::string property)
  {
    return GetGlobal<C>().get_value(property);
  }
 
  template<typename T>
  std::list<T>* Parser::ArrayToList(Array* arrayIn)
  {
    if (!arrayIn)
      {return nullptr;}
    else
    {
      std::list<T>* result = new std::list<T>();
      const auto& doubleData = arrayIn->GetDataList();
      for (auto& value : doubleData)
      {result->push_back((T)value);}
      return result;
    }
  }
}
 
#endif