calltipprovider.hpp

Go to the documentation of this file.

/*****************************************************************************
    NumeRe: Framework fuer Numerische Rechnungen
    Copyright (C) 2022  Erik Haenel et al.
 
    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 CALLTIPPROVIDER_HPP
#define CALLTIPPROVIDER_HPP
 
#include <string>
namespace NumeRe
{
    struct CallTip
    {
        std::string sDefinition;
        std::string sDocumentation;
        size_t nStart;
        size_t nEnd;
 
        CallTip() : nStart(0u), nEnd(0u) {}
        CallTip(const std::string& sDef, const std::string& sDoc = "", size_t s = 0u, size_t e = 0u)
            : sDefinition(sDef), sDocumentation(sDoc), nStart(s), nEnd(e) {}
    };
 
 
 
 
 
    class CallTipProvider
    {
        private:
            size_t m_maxLineLength;
 
        public:
            CallTipProvider(size_t nMaxLineLength = 100u) : m_maxLineLength(nMaxLineLength) {}
 
            CallTip getCommand(std::string sToken) const;
            CallTip getFunction(std::string sToken) const;
            CallTip getProcedure(std::string sToken) const;
            CallTip getOption(std::string sToken) const;
            CallTip getMethod(std::string sToken) const;
            CallTip getPredef(std::string sToken) const;
            CallTip getConstant(std::string sToken) const;
    };
 
 
 
 
    CallTip FindProcedureDefinition(const std::string& pathname, const std::string& procedurename);
    CallTip addLinebreaks(CallTip _cTip, size_t maxLineLength = 100u);
}
 
#endif // CALLTIPPROVIDER_HPP