mirror of
https://github.com/cuberite/TCLAP.git
synced 2025-08-04 10:16:41 -04:00
35aa53232d
major problems. 1) There where static functions and variables that could cause link errors if tclap where used in different files (e.g. file1.cc and file2.cc included tclap then compiling both files would give hard symbols for some variables which would produce multiple definition when linking) 2) The dependencies of tclap was a bit strange (CmdLine depends on Args and Args depends on CmdLine for instance) The first problem I solved by removing all static variables putting them in static member functions (which are weak-symbols). So for instance every where there previously was something like x = _delimiter there now is x = delimiter() or in case of write acces delimiterRef() = x instead of _delimiter = x (I had to append the Ref because there where already functions with the same name as the variables). To solve the problem with static functions I simply inlined them. This causes the compiler to produce a weak symbol or inline if appropriate. We can put the functions inside the class declaration later to make the code look better. This worked fine in all but two cases. In the ValueArg and MultiArg classes I had to do a "hack" to work around the specialization template for extractValue<std::string>. The code for this is very simple but it might look strange an stupid at first but it is only to resolve the specialisation to a weak symbol. What I did was I put the implementations of extractValue in a helper class and I could then create a specialized class instead of function and everything worked out. I think now in retrospect there might be better solutions to this but I'll think a bit more on it (maybe some type of inlining on the specialized version would suffice but I'm not sure). To handle the dependencies I had to do some rewriting. The first step was to introduce a new class CmdLineInterface that is a purely abstract base of CmdLine that specifies the functions needed by Arg and friends. Thus Arg classes now takes an CmdLineInterface object as input instead (however only CmdLine can ever be instantiated of-course). With this extra class cleaning up the dependencies was quite simple, I've attached a dependency graph to the mail (depgraph.png). I also cleaned up the #includes so now only what actually needs inclusion is included. A nice side effect of this is that the impl. of CmdLine is now put back into CmdLine.h (where I guess you wanted it) which (recursivly) includes everything else needed. Just to make things clear for myself regarding the class dependencies I made a class TCLAP::Exception that inherits from std::exception and is a base of ArgException (Exception does nothing currently). If we don't want the Exception class it can be removed, however I think it could be a nice logic to have a base Exception class that every exception inherits from, but we can discuss that when we decide how to handle exceptions.
116 lines
2.5 KiB
C++
116 lines
2.5 KiB
C++
|
|
/******************************************************************************
|
|
*
|
|
* file: ArgException.h
|
|
*
|
|
* Copyright (c) 2003, Michael E. Smoot .
|
|
* All rights reverved.
|
|
*
|
|
* See the file COPYING in the top directory of this distribution for
|
|
* more information.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED _AS IS_, WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
|
|
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
* DEALINGS IN THE SOFTWARE.
|
|
*
|
|
*****************************************************************************/
|
|
|
|
|
|
#ifndef TCLAP_ARG_EXCEPTION_H
|
|
#define TCLAP_ARG_EXCEPTION_H
|
|
|
|
#include <string>
|
|
#include <exception>
|
|
|
|
namespace TCLAP {
|
|
|
|
/**
|
|
* A simple class that defines and argument exception. Should be caught
|
|
* whenever a CmdLine is created and parsed.
|
|
*/
|
|
class ArgException : public std::exception
|
|
{
|
|
public:
|
|
|
|
/**
|
|
* Constructor.
|
|
* \param text - The text of the exception.
|
|
* \param id - The text identifying the argument source
|
|
* of the exception.
|
|
*/
|
|
ArgException( const std::string& text = "undefined exception",
|
|
const std::string& id = "undefined" )
|
|
: std::exception(), _errorText(text), _argId( id ) { }
|
|
|
|
/**
|
|
* Copy constructor.
|
|
* \param e - The ArgException that will be copied.
|
|
*/
|
|
ArgException(const ArgException& e)
|
|
: _errorText(e._errorText), _argId(e._argId) { }
|
|
|
|
/**
|
|
* Destructor.
|
|
*/
|
|
virtual ~ArgException() throw() { }
|
|
|
|
|
|
/**
|
|
* Assignment operator.
|
|
* \param e - The ArgException that will be assigned
|
|
* to this.
|
|
*/
|
|
ArgException& operator=( const ArgException& e )
|
|
{
|
|
if ( this != &e )
|
|
{
|
|
_errorText = e._errorText;
|
|
_argId = e._argId;
|
|
}
|
|
return *this;
|
|
}
|
|
|
|
/**
|
|
* Returns the error text.
|
|
*/
|
|
std::string error() const { return ( _errorText ); }
|
|
|
|
/**
|
|
* Returns the argument id.
|
|
*/
|
|
std::string argId() const
|
|
{
|
|
if ( _argId == "undefined" )
|
|
return " ";
|
|
else
|
|
return ( "Argument: " + _argId );
|
|
}
|
|
|
|
/**
|
|
* Returns the error text.
|
|
*/
|
|
const char* what() throw() { return _errorText.c_str(); }
|
|
|
|
private:
|
|
|
|
/**
|
|
* The text of the exception message.
|
|
*/
|
|
std::string _errorText;
|
|
|
|
/**
|
|
* The argument related to this exception.
|
|
*/
|
|
std::string _argId;
|
|
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|
|
|