element.h

Go to the documentation of this file.

/* -*- Mode: c++ -*- */
/*
 *  this is part of Spm
 *
 *  Copyright (c) 2005-2007 Guillaume Chevallereau
 *
 *  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 of the license or (at your 
 *  option) any later version.
 *
 *  This program is distributed in the hope that it will be usefull 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 __ELEMENT_H__
#define __ELEMENT_H__

#include <string>
#include <list>
#include <map>
#include <fstream>
#include "branch.h"
#include "category.h"
#include "coreException.h"
#include <plugin/installerInterface.h>
#include <util/object.h>

#include <functional>
#include <algorithm>
//#include <boost/thread.hpp>

namespace Spm
{
  namespace Core
  {
    const std::string ELEMENT_ATTRIBUTE_NAME = "name";
    const std::string ELEMENT_NODE_DESCRIPTION = "description";
    const std::string ELEMENT_NODE_BRANCHES = "branches";
    const std::string ELEMENT_NODE_BRANCH = "branch";
    const std::string ELEMENT_ATTRIBUTE_ELEMENT = "element";
    const std::string ELEMENT_ATTRIBUTE_VERSION = "version";
    const std::string ELEMENT_NODE_CATEGORY = "category";
    class Element : public Util::Object
    {
      friend class Store;
    public :
      typedef std::list<Branch *>::iterator iterator;
      typedef std::list<Branch *>::const_iterator const_iterator;
      typedef std::list<Branch *>::reverse_iterator reverse_iterator;
      typedef std::list<Branch *>::const_reverse_iterator const_reverse_iterator;
    protected:
      Category * category;
      std::string description;
      std::string elementURL;
      std::list<Branch *> branches;
      Element ();

    public:
      virtual ~Element ();

      const std::string & getDescription ();

      const std::string & getDescription () const;
      
      void setName (const std::string & name);

      void setDescription (const std::string & description);
      
      const Category * getCategory ();

      const Category * getCategory () const;

      void setCategory (Category * aCategory);
      
      void addBranch (Branch * aBranch)
        throw (AlreadyExistingBranchException);

      void removeBranch (const std::string & aBranch)
        throw (UnknownBranchException, NoRightException);

      std::list<Branch *> & getBranches ();
      const std::list<Branch *> & getBranches () const;
      
      std::list<Branch *> getUserBranches (const std::string & user);

      std::list<Branch *> getSystemBranches ();

      const Branch * getBranch (const std::string & branchName)
        throw (UnknownBranchException);

      Branch * getRefBranch (const std::string & branchName)
        throw (UnknownBranchException);      
      
      virtual bool uninstall (const std::string & branchName = "")
        throw (UnknownBranchException);

      virtual Branch * queryForFile (const std::string & file)
        throw (FileNotFoundException);

      std::list<Branch *> findSameBranch (const std::string & branchName)
        throw (UnknownBranchException);

      bool operator< (const Element * e) const;
      bool operator< (const Element & e) const;

      iterator begin ()
      {
        return branches.begin ();
      }

      iterator end ()
      {
        return branches.end ();
      }

      const_iterator begin () const
      {
        return branches.begin ();
      }

      const_iterator end () const
      {
        return branches.end ();
      }

      reverse_iterator rbegin ()
      {
        return branches.rbegin ();
      }

      reverse_iterator rend ()
      {
        return branches.rend ();
      }

      const_reverse_iterator rbegin () const
      {
        return branches.rbegin ();
      }

      const_reverse_iterator rend () const
      {
        return branches.rend ();
      }
    };

    struct equalElement : public std::binary_function<Element *, std::string, bool>
    {
      bool operator() (Element * element,
                       const std::string & elementName) const;
    };

    struct equalBranchByBranch : public std::binary_function<Branch *, Branch *, bool>
    {
      bool operator()(const Branch * branch, const Branch * branchToSearch) const;
    };

    struct equalBranch : public std::binary_function<Branch *, std::string, bool>
    {
      bool operator()(const Branch * branch, const std::string & branchName) const;
    };

    struct branchContainFile : public std::binary_function<Branch *, std::string, bool>
    {
      bool operator() (Branch * branch,
                       const std::string & file) const;
    };

    struct equalBranchMajorMinor : public std::binary_function<Branch *, std::string, bool>
    {
      bool operator() (Branch * branch,
                       const std::string & file) const;
    };
  }
}
#endif

---