ParamLine.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 pongasoft
 *
 * Licensed under the Apache License, Version 2.0 or the MIT license,
 * at your option. You may not use this file except in compliance with
 * one of these licenses. You may obtain copies of the licenses at:
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 * https://opensource.org/licenses/MIT
 *
 * 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.
 * 
 * @author Yan Pujante
 */
 
#pragma once
 
#include "ParamDisplay.h"
 
#include <string>
 
namespace pongasoft::VST::Debug {

class ParamLine
{
public:
  explicit ParamLine(ParamDisplay iParamDisplay) : fParamDisplay{std::move(iParamDisplay)} {}
 
  ParamLine &precision(int32 iPrecision) { fParamDisplay.precision(iPrecision); return *this; }
  ParamLine &keys(std::vector<ParamDisplay::Key> const &iKeys) { fParamDisplay.keys(iKeys); return *this; }
  ParamLine &key(ParamDisplay::Key iKey) { fParamDisplay.key(iKey); return *this; }
  ParamLine &ids(std::vector<ParamID> const &iParamIDs) { fParamDisplay.ids(iParamIDs); return *this; }
  ParamLine &id(ParamID iParamID) { fParamDisplay.id(iParamID); return *this; }
  ParamLine &firstSeparator(std::string iString) { fFirstSeparator = std::move(iString); return *this; }
  ParamLine &nextSeparator(std::string iString) { fNextSeparator = std::move(iString); return *this; }
  ParamLine &paramSeparator(std::string iString) { fParamSeparator = std::move(iString); return *this; }
  ParamLine &skipEmptyEntry(bool iFlag = true) { fSkipEmptyEntry = iFlag; return *this; }
 
  // returns a line representation of the params
  std::string toString() const;
 
  // returns a line representation of normalized state
  std::string toString(NormalizedState const &iNormalizedState) const;
 
public:
  static ParamLine from(Parameters const &iParams);

  static ParamLine from(RT::RTState const *iState, bool iSaveStateOnly = false);

  static ParamLine from(GUI::GUIState const *iState, bool iSaveStateOnly = false);
 
protected:
  // toString
  std::string toString(ParamDisplay::ParamMap const &iParamMap) const;
 
private:
  ParamDisplay fParamDisplay;
 
  std::string fFirstSeparator{"="};
  std::string fNextSeparator{"/"};
  std::string fParamSeparator{", "};
  bool fSkipEmptyEntry{true};
};
 
}