L1GtVhdlTemplateFile Class Reference

#include <L1GtVhdlTemplateFile.h>

Public Member Functions
void	append (const std::string &str)
	adds a line at the end of the the file with the content of str More...
void	append (const L1GtVhdlTemplateFile &file)
	adds the content of file at the end of (*this); the parameter map won't be changed More...
bool	close ()
bool	extractParametersFromString (const std::string &str, std::vector< std::string > &parameters) const
void	getConditionsFromAlgo (std::string condString, std::vector< std::string > &result) const
	extracts all conditions from a algorithm More...
std::string	getInternalParameter (const std::string &indentifier)
	returns a parameter of a internal template file More...
std::vector< std::string >	getSubstitutionParametersFromTemplate () const
	returns a vector with all substitution parameters that are found in the template file More...
bool	insert (const std::string &atLine, const std::vector< std::string > &content)
	replaces the whole line containing atLine and inserts content instead of it More...
bool	insert (const std::string atLine, const L1GtVhdlTemplateFile &file)
	replaces the whole line containing atLine with the content of file More...
bool	isBlank (const char &chr) const
	checks weather a char is a blank More...
	L1GtVhdlTemplateFile ()
	standard constructor More...
	L1GtVhdlTemplateFile (const std::string &filename)
	constructor with filename More...
std::string	lines2String () const
	returns a string with the content of vector lines More...
bool	open (const std::string &fileName, bool internal=false)
	opens a template file. If the header information shall be parsed intern has to be set to true More...
void	print () const
	prints the content of the VHDL File (only lines_) More...
void	printParameterMap () const
	prints the parameter map More...
bool	removeEmptyLines ()
	deletes all empty lines in a template file More...
bool	removeLineWithContent (const std::string &str)
	removes all lines that contain the str More...
std::vector< std::string >	returnLines () const
	returns a string vector with the current content of the VHDL File More...
std::map< std::string, std::string >	returnParameterMap () const
	returns parameter map More...
bool	save (const std::string &fileName)
	saves the content of the template file to a local file (the content of parameterMap_ will not be saved!) More...
bool	split (const std::string &param, std::vector< std::string > &result) const
	seperates a string at all blanks and saves the elements in result More...
bool	substitute (const std::string &searchString, const std::string &replaceString)
	replaces searchString with replaceString More...

Static Public Member Functions
static const bool	findAndReplaceString (std::string &paramString, const std::string &searchString, const std::string &replaceString)
	replaces searchString with replaceString at it's first occurance in string More...

Private Attributes
bool	intern_
std::vector< std::string >	lines_
	containing the content of the VHDL file More...
std::map< std::string, std::string >	parameterMap_
	containing the header information of internal files More...

Detailed Description

The routines of this class provide all necessary features to deal with the VHDL templates for the firmware code of the GT

Implementation: <TODO: enter implementation details>

Author

Philipp Wagner

Description: a class to deal with VHDL template files

Implementation: <TODO: enter implementation details>

Author

: Philipp Wagner

Definition at line 25 of file L1GtVhdlTemplateFile.h.

Constructor & Destructor Documentation

L1GtVhdlTemplateFile() [1/2]

L1GtVhdlTemplateFile::L1GtVhdlTemplateFile

(

)

standard constructor

Definition at line 29 of file L1GtVhdlTemplateFile.cc.

References intern_.

{ intern_ = false; }

L1GtVhdlTemplateFile() [2/2]

L1GtVhdlTemplateFile::L1GtVhdlTemplateFile

(

const std::string &

filename

)

constructor with filename

Definition at line 32 of file L1GtVhdlTemplateFile.cc.

References gather_cfg::cout, corrVsCorr::filename, and open().

                                                                    {
  if (!open(filename, false))
    std::cout << "Error while opening file: " << filename << std::endl;
}

Member Function Documentation

append() [1/2]

void L1GtVhdlTemplateFile::append

(

const std::string &

str

)

adds a line at the end of the the file with the content of str

Definition at line 267 of file L1GtVhdlTemplateFile.cc.

References lines_, and str.

Referenced by diclist.diclist::add(), L1GtVhdlWriterCore::getCondChipVhdContentFromTriggerMenu(), and L1GtVhdlWriterCore::writeMuonSetupVhdl().

{ lines_.push_back(str); }

append() [2/2]

void L1GtVhdlTemplateFile::append

(

const L1GtVhdlTemplateFile &

file

)

adds the content of file at the end of (*this); the parameter map won't be changed

Definition at line 269 of file L1GtVhdlTemplateFile.cc.

References geometryDiff::file, mps_fire::i, and lines_.

Referenced by diclist.diclist::add().

                                                                  {
  for (unsigned int i = 0; i < file.lines_.size(); i++) {
    lines_.push_back(file.lines_.at(i));
  }
}

close()

bool L1GtVhdlTemplateFile::close

(

void

)

Definition at line 197 of file L1GtVhdlTemplateFile.cc.

Referenced by esMonitoring.AsyncLineReaderMixin::handle_close(), and esMonitoring.FDJsonServer::handle_close().

                                 {
  //empty
  return true;
}

extractParametersFromString()

bool L1GtVhdlTemplateFile::extractParametersFromString	(	const std::string &	str,
		std::vector< std::string > &	parameters
	)		const

finds all substitution parameters in str and collects them in the vector parameters. This routine is used by getSubstitutionParametersFromTemplate();

Definition at line 226 of file L1GtVhdlTemplateFile.cc.

References str, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by getSubstitutionParametersFromTemplate().

                                                                                               {
  // check, weather the current line is containing a substitution parameter
  // the routine is making sure, that it's not extracting a parameter from
  // a comment
  if (int pos1 = str.find("$(") != std::string::npos && str.substr(0, 2) != "--") {
    int pos2 = str.find(')');
    // get the substituion parameter
    std::string tempStr = (str.substr(pos1 + 1, (pos2 - pos1 - 1)));
    // return a pair with the substitution parameter and the
    // the rest of the string after the substitution parameter

    // here a should be checked, weather the vector is already containing
    // the parameter befor adding it.

    parameters.push_back(tempStr);
    //recursive call
    while (extractParametersFromString(str.substr(pos2), parameters))
      extractParametersFromString(str.substr(pos2), parameters);

    return true;
  } else {
    return false;
  }

  return true;
}

findAndReplaceString()

const bool L1GtVhdlTemplateFile::findAndReplaceString ( std::string &  paramString, const std::string &  searchString, const std::string &  replaceString  )

static

replaces searchString with replaceString at it's first occurance in string

Definition at line 37 of file L1GtVhdlTemplateFile.cc.

References position, and edm::replaceString().

Referenced by L1GtVhdlWriterCore::buildDefValuesBuffer(), L1GtVhdlWriterCore::getCondChipVhdContentFromTriggerMenu(), getConditionsFromAlgo(), L1GtVhdlWriterCore::getSubstParamCommonFromTriggerMenu(), substitute(), L1GtVhdlWriterCore::writeAlgoSetup(), L1GtVhdlWriterCore::writeCondChipPkg(), L1GtVhdlWriterCore::writeConditionChipSetup(), L1GtVhdlWriterCore::writeDefValPkg(), L1GtVhdlWriterCore::writeEtmSetup(), L1GtVhdlWriterCore::writeMuonSetupVhdl(), and L1GtVhdlWriterCore::writeQsfSetupFiles().

                                                                                      {
  size_t position;
  position = paramString.find(searchString);
  if (position == std::string::npos)
    return false;
  paramString.replace(position, searchString.length(), replaceString);
  return true;
}

getConditionsFromAlgo()

void L1GtVhdlTemplateFile::getConditionsFromAlgo	(	std::string	condString,
		std::vector< std::string > &	result
	)		const

extracts all conditions from a algorithm

Definition at line 335 of file L1GtVhdlTemplateFile.cc.

References findAndReplaceString(), mps_fire::i, mps_fire::result, and split().

                                                                                                         {
  std::vector<std::string> operators;

  operators.push_back("AND");
  operators.push_back("OR");
  operators.push_back("NOT");
  operators.push_back("(");
  operators.push_back(")");

  for (unsigned int i = 0; i < operators.size(); i++) {
    while (findAndReplaceString(condString, operators.at(i), ""))
      findAndReplaceString(condString, operators.at(i), "");
  }

  split(condString, result);
}

getInternalParameter()

std::string L1GtVhdlTemplateFile::getInternalParameter

(

const std::string &

indentifier

)

returns a parameter of a internal template file

Definition at line 364 of file L1GtVhdlTemplateFile.cc.

References parameterMap_.

Referenced by L1GtVhdlWriterCore::buildDefValuesBuffer(), and L1GtVhdlWriterCore::writeDefValPkg().

                                                                                 {
  return parameterMap_[indentifier];
}

getSubstitutionParametersFromTemplate()

std::vector< std::string > L1GtVhdlTemplateFile::getSubstitutionParametersFromTemplate

(

)

const

returns a vector with all substitution parameters that are found in the template file

Definition at line 254 of file L1GtVhdlTemplateFile.cc.

References extractParametersFromString(), lines_, and groupFilesInBlocks::temp.

Referenced by L1GtVhdlWriterCore::writeMuonSetupVhdl().

                                                                                       {
  std::vector<std::string> temp;
  std::vector<std::string>::const_iterator iter = lines_.begin();

  // loop until the substitution parameter is discovered the first time
  while (iter != lines_.end()) {
    extractParametersFromString((*iter), temp);
    iter++;
  }

  return temp;
}

insert() [1/2]

bool L1GtVhdlTemplateFile::insert	(	const std::string &	atLine,
		const std::vector< std::string > &	content
	)

replaces the whole line containing atLine and inserts content instead of it

Definition at line 165 of file L1GtVhdlTemplateFile.cc.

References submitPVResolutionJobs::content, lines_, and summarizeEdmComparisonLogfiles::success.

Referenced by L1GtVhdlWriterCore::buildCommonHeader(), insert(), L1GtVhdlWriterCore::openVhdlFileWithCommonHeader(), L1GtVhdlWriterCore::writeCondChipPkg(), L1GtVhdlWriterCore::writeConditionChipSetup(), L1GtVhdlWriterCore::writeDefValPkg(), and L1GtVhdlWriterCore::writeMuonSetupVhdl().

                                                                                              {
  bool success = false;
  std::vector<std::string>::iterator iter = lines_.begin();

  //Loop until the substitution parameter is discovered the first time
  while (iter != lines_.end()) {
    //check, weather the current line is containing the substitution parameter
    if ((*iter).find(atLine) != std::string::npos) {
      //Delete the line with the subsitution parameter
      iter = lines_.erase(iter);
      //insert the content of file
      lines_.insert(iter, content.begin(), content.end());

      success = true;
      break;
    }

    iter++;
  }

  return success;
}

insert() [2/2]

bool L1GtVhdlTemplateFile::insert	(	const std::string	atLine,
		const L1GtVhdlTemplateFile &	file
	)

replaces the whole line containing atLine with the content of file

Definition at line 188 of file L1GtVhdlTemplateFile.cc.

References findAndChange::_file, insert(), and groupFilesInBlocks::temp.

                                                                                           {
  std::vector<std::string> temp = _file.returnLines();

  if (insert(atLine, temp))
    return true;

  return false;
}

isBlank()

bool L1GtVhdlTemplateFile::isBlank

(

const char &

chr

)

const

checks weather a char is a blank

Definition at line 305 of file L1GtVhdlTemplateFile.cc.

Referenced by split().

                                                        {
  if (chr == ' ')
    return true;
  return false;
}

lines2String()

std::string L1GtVhdlTemplateFile::lines2String

(

)

const

returns a string with the content of vector lines

Definition at line 352 of file L1GtVhdlTemplateFile.cc.

References edmScanValgrind::buffer, and lines_.

                                                   {
  std::vector<std::string>::const_iterator iter = lines_.begin();
  std::ostringstream buffer;

  while (iter != lines_.end()) {
    buffer << (*iter) << std::endl;
    iter++;
  }

  return buffer.str();
}

open()

bool L1GtVhdlTemplateFile::open	(	const std::string &	fileName,
		bool	internal = false
	)

opens a template file. If the header information shall be parsed intern has to be set to true

Definition at line 48 of file L1GtVhdlTemplateFile.cc.

References edmScanValgrind::buffer, MillePedeFileConverter_cfg::fileName, recoMuon::in, makeListRunsInFiles::inputFile, lines_, parameterMap_, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by L1GtVhdlWriterCore::buildCommonHeader(), L1GtVhdlWriterCore::buildDefValuesBuffer(), L1GtVhdlWriterCore::getCondChipVhdContentFromTriggerMenu(), L1GtVhdlTemplateFile(), L1GtVhdlWriterCore::writeDefValPkg(), L1GtVhdlWriterCore::writeMuonSetupVhdl(), and L1GtVhdlWriterCore::writeQsfSetupFiles().

                                                                        {
  const char paramIndicator = '#';
  const char commentIndicator = '%';
  char buffer[2000];
  std::string stringBuffer;

  std::fstream inputFile(fileName.c_str(), std::ios::in);
  //check weather file has been opened successfully
  if (!inputFile.is_open())
    return false;

  //store content of the template in Vector lines
  while (!inputFile.eof()) {
    inputFile.getline(buffer, 2000);
    stringBuffer = buffer;
    //Remove DOS seperators (For example if the template file was created under NT)
    if (stringBuffer[stringBuffer.length() - 1] == 13) {
      stringBuffer.replace(stringBuffer.length() - 1, 1, "");
    }
    //the current buffer + a seperator to the vector lines
    lines_.push_back(stringBuffer /*+"\n"*/);
  }

  inputFile.close();

  if (internal) {
    //Delete lines containing parameters after moving them to parameterMap_
    std::vector<std::string>::iterator iter = lines_.begin();
    while (iter != lines_.end()) {
      while ((*iter)[0] == commentIndicator && (*iter)[1] == commentIndicator)
        lines_.erase(iter);

      if ((*iter)[0] == paramIndicator) {
        std::vector<std::string>::iterator iter2 = iter;

        // get the first line of content
        iter2++;

        while (iter2 != lines_.end()) {
          if ((*iter2)[0] == paramIndicator && (*iter2)[1] == paramIndicator) {
            iter2++;
            break;
          }

          parameterMap_[(*iter).substr(1)] += (*iter2);

          // overtake the newlines
          std::vector<std::string>::iterator tmpIter = iter2;
          tmpIter++;

          // check weather the next line is the end of the block
          if (!((*tmpIter)[0] == paramIndicator && (*tmpIter)[1] == paramIndicator))
            parameterMap_[(*iter).substr(1)] += "\n";

          iter2++;
        }

        // there has been a syntax error in the internal template
        // stop the routine
        if (iter2 == lines_.end())
          return false;

        // deletes the content, thas has been added to parameter map before
        // (iter one at the moment is at the beginnig of the block, iter2 at its end)
        lines_.erase(iter, iter2);
      }

      // just for security
      if (iter != lines_.end())
        iter++;
    }

    //remove empty lines
    iter = lines_.begin();
    while (iter != lines_.end()) {
      if ((*iter).empty() || (*iter).length() == 0 || (*iter) == "    ")
        lines_.erase(iter);
      else
        iter++;
    }
  }

  return true;
}

print()

void L1GtVhdlTemplateFile::print

(

void

)

const

prints the content of the VHDL File (only lines_)

Definition at line 202 of file L1GtVhdlTemplateFile.cc.

References gather_cfg::cout, and lines_.

Referenced by L1GtVhdlWriterCore::printCommonHeader().

                                       {
  std::vector<std::string>::const_iterator iter = lines_.begin();
  while (iter != lines_.end()) {
    std::cout << *iter << std::endl;
    iter++;
  }
}

printParameterMap()

void L1GtVhdlTemplateFile::printParameterMap

(

)

const

prints the parameter map

Definition at line 212 of file L1GtVhdlTemplateFile.cc.

References gather_cfg::cout, and parameterMap_.

                                                   {
  std::cout << "Enter parametermap" << std::endl;

  std::map<std::string, std::string>::const_iterator iter = parameterMap_.begin();

  while (iter != parameterMap_.end()) {
    std::cout << (*iter).first << ": " << (*iter).second << std::endl;
    iter++;
    ;
  }
}

removeEmptyLines()

bool L1GtVhdlTemplateFile::removeEmptyLines

(

)

deletes all empty lines in a template file

Definition at line 292 of file L1GtVhdlTemplateFile.cc.

References lines_.

Referenced by L1GtVhdlWriterCore::getCondChipVhdContentFromTriggerMenu().

                                            {
  std::vector<std::string>::iterator iter = lines_.begin();

  while (iter != lines_.end()) {
    if ((*iter).empty() || (*iter).length() == 0 || (*iter) == "    ")
      lines_.erase(iter);
    else
      iter++;
  }

  return true;
}

removeLineWithContent()

bool L1GtVhdlTemplateFile::removeLineWithContent

(

const std::string &

str

)

removes all lines that contain the str

Definition at line 275 of file L1GtVhdlTemplateFile.cc.

References lines_, position, str, and summarizeEdmComparisonLogfiles::success.

Referenced by L1GtVhdlWriterCore::writeMuonSetupVhdl().

                                                                     {
  bool success = false;

  std::vector<std::string>::iterator iter = lines_.begin();
  while (iter != lines_.end()) {
    size_t position;
    position = (*iter).find(str);

    if (position != std::string::npos) {
      lines_.erase(iter);
      success = true;
    } else
      iter++;
  }
  return success;
}

returnLines()

std::vector< std::string > L1GtVhdlTemplateFile::returnLines

(

)

const

returns a string vector with the current content of the VHDL File

Definition at line 210 of file L1GtVhdlTemplateFile.cc.

References lines_.

{ return lines_; }

returnParameterMap()

std::map< std::string, std::string > L1GtVhdlTemplateFile::returnParameterMap

(

)

const

returns parameter map

Definition at line 224 of file L1GtVhdlTemplateFile.cc.

References parameterMap_.

Referenced by L1GtVhdlWriterCore::getCondChipVhdContentFromTriggerMenu(), L1GtVhdlWriterCore::getSubstParamCommonFromTriggerMenu(), and L1GtVhdlWriterCore::writeMuonSetupVhdl().

{ return parameterMap_; }

save()

bool L1GtVhdlTemplateFile::save

(

const std::string &

fileName

)

saves the content of the template file to a local file (the content of parameterMap_ will not be saved!)

Definition at line 133 of file L1GtVhdlTemplateFile.cc.

References MillePedeFileConverter_cfg::fileName, lines_, and download_sqlite_cfg::outputFile.

Referenced by L1GtVhdlWriterCore::writeAlgoSetup(), L1GtVhdlWriterCore::writeCondChipPkg(), L1GtVhdlWriterCore::writeConditionChipSetup(), L1GtVhdlWriterCore::writeDefValPkg(), L1GtVhdlWriterCore::writeEtmSetup(), L1GtVhdlWriterCore::writeMuonSetupVhdl(), and L1GtVhdlWriterCore::writeQsfSetupFiles().

                                                         {
  std::ofstream outputFile(fileName.c_str());
  std::vector<std::string>::iterator iter = lines_.begin();

  //Write content of lines_ into the outputfile.
  while (iter != lines_.end()) {
    //std::cout<<"Last sign: "<<*iter[(*iter).length()-3];
    outputFile << *iter << std::endl;
    iter++;
  }

  outputFile.close();

  return true;
}

split()

bool L1GtVhdlTemplateFile::split	(	const std::string &	param,
		std::vector< std::string > &	result
	)		const

seperates a string at all blanks and saves the elements in result

Definition at line 311 of file L1GtVhdlTemplateFile.cc.

References mps_fire::i, isBlank(), mps_fire::result, AlCaHLTBitMon_QueryRunRegistry::string, and groupFilesInBlocks::temp.

Referenced by getConditionsFromAlgo().

                                                                                           {
  unsigned int i = 0;
  while (isBlank(param[i])) {
    i++;
  }

  std::string temp = param.substr(i);
  std::size_t pos = temp.find(' ');

  if (pos != std::string::npos) {
    std::string temp2 = temp.substr(0, pos);
    result.push_back(temp2);
    while (split(temp.substr(pos), result))
      split(temp.substr(pos), result);

  } else if (!isBlank(temp[pos + 1])) {
    result.push_back(temp);
    return false;
  } else
    return false;

  return false;
}

substitute()

bool L1GtVhdlTemplateFile::substitute	(	const std::string &	searchString,
		const std::string &	replaceString
	)

replaces searchString with replaceString

Definition at line 149 of file L1GtVhdlTemplateFile.cc.

References findAndReplaceString(), lines_, edm::replaceString(), and summarizeEdmComparisonLogfiles::success.

Referenced by L1GtVhdlWriterCore::buildCommonHeader(), L1GtVhdlWriterCore::buildDefValuesBuffer(), L1GtVhdlWriterCore::getCondChipVhdContentFromTriggerMenu(), L1GtVhdlWriterCore::openVhdlFileWithCommonHeader(), L1GtVhdlWriterCore::writeAlgoSetup(), L1GtVhdlWriterCore::writeCondChipPkg(), L1GtVhdlWriterCore::writeConditionChipSetup(), L1GtVhdlWriterCore::writeEtmSetup(), L1GtVhdlWriterCore::writeMuonSetupVhdl(), and L1GtVhdlWriterCore::writeQsfSetupFiles().

                                                                                                   {
  bool success = false;

  std::vector<std::string>::iterator iter = lines_.begin();
  while (iter != lines_.end()) {
    //The substitution parameter always appears as follows: $(parameter)
    while (findAndReplaceString(*iter, ("$(" + searchString + ")"), replaceString)) {
      findAndReplaceString(*iter, ("$(" + searchString + ")"), replaceString);
      success = true;
    }
    iter++;
  }

  return success;
}

Member Data Documentation

intern_

bool L1GtVhdlTemplateFile::intern_

private

internal files additionally have entries in parameterMap_ for "normal" files parameterMap is empty

Definition at line 29 of file L1GtVhdlTemplateFile.h.

Referenced by L1GtVhdlTemplateFile().

lines_

std::vector<std::string> L1GtVhdlTemplateFile::lines_

private

containing the content of the VHDL file

Definition at line 31 of file L1GtVhdlTemplateFile.h.

Referenced by append(), getSubstitutionParametersFromTemplate(), insert(), lines2String(), open(), print(), removeEmptyLines(), removeLineWithContent(), returnLines(), save(), and substitute().

parameterMap_

std::map<std::string, std::string> L1GtVhdlTemplateFile::parameterMap_

private

containing the header information of internal files

Definition at line 33 of file L1GtVhdlTemplateFile.h.

Referenced by getInternalParameter(), open(), printParameterMap(), and returnParameterMap().