command.h

Go to the documentation of this file.

/*-------------------------------------------------------------------
Copyright 2011 Ravishankar Sundararaman

This file is part of JDFTx.

JDFTx 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.

JDFTx 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 JDFTx.  If not, see <http://www.gnu.org/licenses/>.
-------------------------------------------------------------------*/

#ifndef JDFTX_COMMAND_COMMAND_H
#define JDFTX_COMMAND_COMMAND_H

#include <electronic/common.h>
#include <commands/ParamList.h>
#include <core/string.h>
#include <memory>
#include <set>

class Command
{
public:
        string name; 
        string format; 
        string comments; 
        string section; 
        string category; 
        string subcategory; 
        
        std::set<string> requires; 
        std::set<string> forbids; 

        bool allowMultiple; 
        bool hasDefault; 
        string emptyParamError; 
        
        virtual void process(ParamList& pl, Everything& e)=0;

        virtual void printStatus(Everything& e, int iRep)=0;

protected:
        Command(string name, string path);

        void require(string); 
        void forbid(string); 
};

class DeprecatedCommand
{
public:
        string name;
        DeprecatedCommand(string name);
        
        //Return a replacement command and arguments pair
        virtual std::pair<string,string> replace(ParamList& pl) const=0;
};

std::map<string,Command*>& getCommandMap(); 
std::map<string,DeprecatedCommand*>& getDeprecatedMap(); 

static EnumStringMap<bool> boolMap(false, "no", true, "yes"); 


template<typename GetDescription>
string addDescriptions(string optionList, const GetDescription& getDescription, string spacer="\n+ ")
{
        //Determine max width of name, so as to align:
        istringstream iss(optionList);
        size_t nameWidth=0;
        while(!iss.eof())
        {       string name;
                getline(iss, name, '|');
                trim(name);
                nameWidth = std::max(name.length(),nameWidth);
        }
        //Process decsription list:
        iss.seekg(0, std::ios::beg); //rewind;
        string ret;
        while(!iss.eof())
        {       //Get a name from the option list:
                string name;
                getline(iss, name, '|');
                trim(name);
                if(!name.length()) break;
                //Get the description:
                string desc = getDescription(name);
                //Pad the name to required width:
                if(name.length()<nameWidth)
                        name.resize(nameWidth, ' ');
                ret += spacer + name;
                if(desc.length()) ret += ": " + desc;
        }
        return ret;
}

inline string nullDescription(const string&)
{       return string();
}

template<typename Enum> struct LinkDescription
{       const EnumStringMap<Enum>& nameMap;
        const EnumStringMap<Enum>& descMap;
        
        LinkDescription(const EnumStringMap<Enum>& nameMap, const EnumStringMap<Enum>& descMap)
        : nameMap(nameMap), descMap(descMap)
        {
        }
        
        string operator()(const string& name) const
        {       Enum type = Enum();
                bool nameFound = nameMap.getEnum(name.c_str(), type);
                assert(nameFound);
                return descMap.getString(type);
        }
};

template<typename Enum>
LinkDescription<Enum> linkDescription(const EnumStringMap<Enum>& nameMap, const EnumStringMap<Enum>& descMap)
{       return LinkDescription<Enum>(nameMap, descMap);
}

std::shared_ptr<SpeciesInfo> findSpecies(string id, Everything& e);

bool isReadable(string fname);

#endif // JDFTX_COMMAND_COMMAND_H