methods.h

Go to the documentation of this file.

/* Copyright (C) 2000, 2001 Stefan Buehler <sbuehler@uni-bremen.de>

   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 2, 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, write to the Free Software
   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
   USA. */

#ifndef methods_h
#define methods_h

#include "token.h"
#include "make_array.h"

class MdRecord {
public:

  MdRecord():
      mname(      ""              ),
    mdescription( ""              ),
    moutput(      0               ),  
    minput(       0               ),   
    mgoutput(     0               ),  
    mginput(      0               ),   
    mkeywords(    0               ),
    mtypes(       0               )
  {};

  MdRecord(const char                   name[],
           const char                   description[],
           const MakeArray<Index>&      output,
           const MakeArray<Index>&      input,   
           const MakeArray<Index>&      goutput,
           const MakeArray<Index>&      ginput,   
           const MakeArray<String>&     keywords,
           const MakeArray<TokValType>& types) :
    mname(        name            ),
    mdescription( description     ),
    moutput(      output          ),  
    minput(       input           ),   
    mgoutput(     goutput         ),  
    mginput(      ginput          ),   
    mkeywords(    keywords        ),
    mtypes(       types           )
    { 
      // Initializing the various arrays with input data should now
      // work correctly.  

      // Keywords and type must have the same number of
      // elements. (Types specifies the types associated with each
      // keyword.)
      assert( mkeywords.nelem() == mtypes.nelem() );
    }
  
  const String&            Name()         const { return mname;        }   
  const String&            Description()  const { return mdescription; }
  const ArrayOfIndex&      Output()       const { return moutput;      }
  const ArrayOfIndex&      Input()        const { return minput;       }
  const ArrayOfIndex&      GOutput()      const { return mgoutput;      }
  const ArrayOfIndex&      GInput()       const { return mginput;       }
  const Array<String>&     Keywords()     const { return mkeywords;    }
  const Array<TokValType>& Types()        const { return mtypes;       }

  ostream& PrintTemplate(ostream& os, bool show_description=true) const;

  MdRecord operator=(const MdRecord&){
    cout << "MdRecord cannot be assigned!\n";
    exit(1);
      }
private:

  String mname;

  String mdescription;

  ArrayOfIndex moutput;

  ArrayOfIndex minput;

  ArrayOfIndex mgoutput;

  ArrayOfIndex mginput;

  ArrayOfString mkeywords;

  Array<TokValType> mtypes;

};


// Some #defines and typedefs to make the records better readable:
#define NAME(x) x 
#define DESCRIPTION(x) x
#define OUTPUT   MakeArray<Index>
#define INPUT    MakeArray<Index>
#define GOUTPUT  MakeArray<Index>
#define GINPUT   MakeArray<Index>
#define KEYWORDS MakeArray<String>
#define TYPES    MakeArray<TokValType>

void define_md_data();

void define_md_map();

ostream& operator<<(ostream& os, const MdRecord& mdr);


#endif  // methods_h

---