/*
 * See the dyninst/COPYRIGHT file for copyright information.
 * 
 * We provide the Paradyn Tools (below described as "Paradyn")
 * on an AS IS basis, and do not warrant its validity or performance.
 * We reserve the right to update, modify, or discontinue this
 * software at any time.  We shall have no obligation to supply such
 * updates or modifications or any other form of support to you.
 * 
 * By your use of Paradyn, you understand and agree that we (or any
 * other person or entity with proprietary rights in Paradyn) are
 * under no obligation to provide either maintenance services,
 * update services, notices of latent defects, or correction of
 * defects for Paradyn.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

#if !defined(_Variable_h_)
#define _Variable_h_

#include <ostream>
#include <string>
#include <vector>
#include "Annotatable.h"
#include "Symtab.h"
#include "Aggregate.h"
#include "VariableLocation.h"
#include "Type.h"

namespace Dyninst {
namespace SymtabAPI {


class Symbol;
class Symtab;
class Aggregate;
class Function;
class FunctionBase;

class SYMTAB_EXPORT Variable : public Aggregate, public AnnotatableSparse {
	friend class Symtab;
	friend std::ostream &operator<<(std::ostream &os, const Variable &);
	private:
   Variable(Symbol *sym);
   static Variable *createVariable(Symbol *sym);
   
 public:
   Variable();
    /* Symbol management */
    bool removeSymbol(Symbol *sym);      

   void setType(dyncompat::shared_ptr<Type> type);
   void setType(Type* t) { setType(t->reshare()); }
   dyncompat::shared_ptr<Type> getType(Type::do_share_t);
   Type* getType() { return getType(Type::share).get(); }
   bool operator==(const Variable &v);

   friend std::ostream &operator<<(std::ostream &os, Variable const& v) {
	   v.print(os);
	   return os;
   }

 private:

   dyncompat::shared_ptr<Type> type_;

   void print(std::ostream &) const;
};

class SYMTAB_EXPORT localVar : public AnnotatableSparse
{
	friend class typeCommon;
	friend class localVarCollection;

	std::string name_;
	dyncompat::shared_ptr<Type> type_;
	std::string fileName_;
	int lineNum_;
        FunctionBase *func_;
	std::vector<VariableLocation> locs_;
        // We start with an abstract location that may include "the frame
        // pointer" as a register. Once a user requests the location list
        // we concretize it and set this flag.
        bool locsExpanded_;
        
	// scope_t scope;

        void expandLocation(const VariableLocation &var,
                            std::vector<VariableLocation> &ret);

	public:
	localVar() :
        type_(NULL), lineNum_(-1), func_(NULL), locsExpanded_(false) {}
	//  Internal use only
	localVar(std::string name,  dyncompat::shared_ptr<Type> typ, std::string fileName, 
            int lineNum, FunctionBase *f, 
            std::vector<VariableLocation> *locs = NULL);
	localVar(std::string n, Type* t, std::string fn, int l, FunctionBase *f, 
            std::vector<VariableLocation> *ls = NULL)
      : localVar(n, t->reshare(), fn, l, f, ls) {}
            
	// Copy constructor
	localVar(localVar &lvar);
	bool addLocation(const VariableLocation &location);
	~localVar();
	void fixupUnknown(Module *);

	public:
	//  end of functions for internal use only
	std::string &getName();
	dyncompat::shared_ptr<Type> getType(Type::do_share_t);
    Type* getType() { return getType(Type::share).get(); }
	bool setType(dyncompat::shared_ptr<Type> newType);
	bool setType(Type* t) { return setType(t->reshare()); }
	int  getLineNum();
	std::string &getFileName();
	std::vector<VariableLocation> &getLocationLists();
	bool operator==(const localVar &l);
};

}
}

#endif