/* Copyright (C) 2004 Stefan van der Walt <address@hidden>

   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions are
   met:

   1. Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
   2. Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.

  THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */

#ifndef __INDEX_H__
#define __INDEX_H__

#include <locale>
#include <string>
#include <iostream>
#include <map>
#include <vector>

/// toolbox -> desc
typedef std::map< std::string, std::string > toolmap;

/// category -> toolbox.
/// This is a multimap, since some categories appear in more than one toolbox.
typedef std::multimap< std::string, std::string > catmap;

/// function name -> (category, toolbox)
typedef std::map< std::string, catmap::value_type> funmap;

/// variable -> value
typedef std::map< std::string, std::string > varmap;

class Index {

    friend std::ostream& operator<<(std::ostream& os, const Index&);
    
 public:
    bool load(const std::string& fn);
    std::vector<std::string> toolbox_functions(const std::string& toolbox);
    std::string function_toolbox(const std::string& function);

    Index operator+(const Index &);
    
 private:
    toolmap toolboxes;
    catmap categories;
    funmap functions;
    varmap variables;
    varmap fn_descriptions;

    enum linetype {toolbox, category, function, variable, comment};

    void parseline(std::string ln, linetype lt);
    
    inline std::string lstrip(std::string str) {
	unsigned int i = 0;
	while ( std::isspace(str[i]) && (i < str.length()) ) i++;
	return str.substr(i);
    }
    
    inline std::string rstrip(std::string str) {
	int i = str.length();
	while ( std::isspace(str[i-1]) && (i > 0) ) i--;
	return str.substr(0, i);
    }
    
    inline std::string strip(std::string str) {
	return lstrip(rstrip(str));
    }
    
    inline std::string uncomment(std::string str) {
	unsigned int i = 0;
	while ( (str[i] != '#') && (i < str.length()) ) i++;
	return str.substr(0, i);
    }

    void getvar(std::string str, std::string& key, std::string& val);
    
};

#endif