//  $Id: SetOfSymbol.hh,v 4.10 2006/06/08 15:16:26 shane Exp $
// Copyright (c) 2001,2002                        RIPE NCC
//
// All Rights Reserved
//
// Permission to use, copy, modify, and distribute this software and its
// documentation for any purpose and without fee is hereby granted,
// provided that the above copyright notice appear in all copies and that
// both that copyright notice and this permission notice appear in
// supporting documentation, and that the name of the author not be
// used in advertising or publicity pertaining to distribution of the
// software without specific, written prior permission.
//
// THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
// ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS; IN NO EVENT SHALL
// AUTHOR BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
// DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
// AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
//
//
//  Copyright (c) 1994 by the University of Southern California
//  All rights reserved.
//
//  Permission to use, copy, modify, and distribute this software and its
//  documentation in source and binary forms for lawful non-commercial
//  purposes and without fee is hereby granted, provided that the above
//  copyright notice appear in all copies and that both the copyright
//  notice and this permission notice appear in supporting documentation,
//  and that any documentation, advertising materials, and other materials
//  related to such distribution and use acknowledge that the software was
//  developed by the University of Southern California, Information
//  Sciences Institute. The name of the USC may not be used to endorse or
//  promote products derived from this software without specific prior
//  written permission.
//
//  THE UNIVERSITY OF SOUTHERN CALIFORNIA DOES NOT MAKE ANY
//  REPRESENTATIONS ABOUT THE SUITABILITY OF THIS SOFTWARE FOR ANY
//  PURPOSE.  THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
//  IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
//  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE,
//  TITLE, AND NON-INFRINGEMENT.
//
//  IN NO EVENT SHALL USC, OR ANY OTHER CONTRIBUTOR BE LIABLE FOR ANY
//  SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES, WHETHER IN CONTRACT, TORT,
//  OR OTHER FORM OF ACTION, ARISING OUT OF OR IN CONNECTION WITH, THE USE
//  OR PERFORMANCE OF THIS SOFTWARE.
//
//  Questions concerning this software should be directed to 
//  ratoolset@isi.edu.
//
//  Author(s): Cengiz Alaettinoglu <cengiz@ISI.EDU>

#ifndef SetOfSymbol_H
#define SetOfSymbol_H

#include "config.h"
#include <cstdio>
#include "SymbolConjunct.hh"
#include "gnug++/SymbolConjunctPtr.SplayBag.h"
#include "rpsl/rpsl.hh"

typedef class SymbolConjunctPtrSplayBag BagOfSymbolConjunct;
class SetOfUInt;

class SetOfSymbol {
public:
   friend class NormalTerm;

   SetOfSymbol() : conjuncts() {
      _universal = 0;
   }
   SetOfSymbol(SetOfSymbol &);
   ~SetOfSymbol() {
      clear();
   }

   virtual int empty() {
      return (! _universal && conjuncts.empty());
   }

   virtual int universal() {
      return (_universal);
   }

   virtual void clear();

   virtual void make_universal() {
      clear();
      _universal = 1;
   }

   virtual void operator ~  (); // complement
   void operator |= (SetOfSymbol& b); // union
   void operator &= (SetOfSymbol& b); // intersection
   int  operator == (SetOfSymbol& b); // equivalance
   void operator =  (SetOfSymbol& b); // assignment
   void operator =  (const SetOfSymID& b); // assignment
   void operator =  (const SetOfUInt& b); // assignment
   void add(ASt as);
   void add(SymID sid);

   friend std::ostream& operator<<(std::ostream& stream, SetOfSymbol& set);

private:
   BagOfSymbolConjunct conjuncts;
   int _universal;

   void reduce();
   void splice(SetOfSymbol& b);
};

#endif   // SetOfSymbol_H