CfgStrParm.h

//==============================================================================
//
//  CfgStrParm.h
//
//  Copyright (C) 2013-2022  Greg Utas
//
//  This file is part of the Robust Services Core (RSC).
//
//  RSC 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.
//
//  RSC 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 RSC.  If not, see <http://www.gnu.org/licenses/>.
//
#ifndef CFGSTRPARM_H_INCLUDED
#define CFGSTRPARM_H_INCLUDED

#include "CfgParm.h"
#include "NbTypes.h"
#include "SysTypes.h"

//------------------------------------------------------------------------------

namespace NodeBase
{
//  Configuration parameter for string values.
//
class CfgStrParm : public CfgParm
{
public:
   //  Creates a parameter with the specified attributes.
   //
   CfgStrParm(c_string key, c_string def, c_string expl);

   //  Virtual to allow subclassing.
   //
   virtual ~CfgStrParm();

   //  Returns the parameter's current value.
   //
   c_string CurrValue() const { return curr_.c_str(); }

   //  Overridden to display member variables.
   //
   void Display(std::ostream& stream,
      const std::string& prefix, const Flags& options) const override;

   //  Overridden for patching.
   //
   void Patch(sel_t selector, void* arguments) override;
protected:
   //  Returns the parameter's next value.
   //
   c_string NextValue() const { return next_.c_str(); }

   //  Overridden to prefix the parameter's type and allowed values.
   //
   void Explain(std::string& expl) const override;

   //  Overridden to return the parameter's current value.
   //
   std::string GetCurr() const override { return curr_.c_str(); }

   //  Overridden to transfer next_ to curr_.
   //
   void SetCurr() override;

   //  Overridden to set the parameter's next value.  May be overridden
   //  to prevent invalid settings.  If so, invoke this version before
   //  returning true.
   //
   bool SetNext(c_string input) override;
private:
   //  The parameter's current value.
   //
   ProtectedStr curr_;

   //  The value to be set during an appropriate restart.
   //
   ProtectedStr next_;
};
}
#endif