attributesubstitutor.h

Go to the documentation of this file.

/*
 * LibrePCB - Professional EDA for everyone!
 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
 * https://librepcb.org/
 *
 * This program 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, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef LIBREPCB_CORE_ATTRIBUTESUBSTITUTOR_H
#define LIBREPCB_CORE_ATTRIBUTESUBSTITUTOR_H

/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include <QtCore>

#include <functional>

/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {

/*******************************************************************************
 *  Class AttributeSubstitutor
 ******************************************************************************/

class AttributeSubstitutor final {
public:
  using LookupFunction = std::function<QString(const QString&)>;
  using FilterFunction = std::function<QString(const QString&)>;

  // Constructors / Destructor / Operator Overloadings
  AttributeSubstitutor() = delete;
  AttributeSubstitutor(const AttributeSubstitutor& other) = delete;
  AttributeSubstitutor& operator=(const AttributeSubstitutor& rhs) = delete;
  ~AttributeSubstitutor() = delete;

  // General Methods

  static QString substitute(QString str, LookupFunction lookup = nullptr,
                            FilterFunction filter = nullptr) noexcept;

private:  // Methods
  static bool searchVariablesInText(const QString& text, int startPos, int& pos,
                                    int& length, QStringList& keys) noexcept;

  static void applyFilter(QString& str, int& start, int& end,
                          FilterFunction filter) noexcept;

  static bool getValueOfKey(const QString& key, QString& value,
                            LookupFunction lookup) noexcept;
};

/*******************************************************************************
 *  End of File
 ******************************************************************************/

}  // namespace librepcb

#endif