stl_scoped_index.h

//
// Copyright (c) 2014 Limit Point Systems, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

// Interface for class stl_scoped_index.

#ifndef STL_SCOPED_INDEX_H
#define STL_SCOPED_INDEX_H

#ifndef SHEAF_DLL_SPEC_H
#include "SheafSystem/sheaf_dll_spec.h"
#endif

#ifndef ASSERT_CONTRACT_H
#include "SheafSystem/assert_contract.h"
#endif

#ifndef SCOPED_INDEX_H
#include "SheafSystem/scoped_index.h"
#endif

namespace sheaf
{

class SHEAF_DLL_SPEC lexographical_compare_policy
{
 public:

  static bool less_than(const scoped_index& xindex1,
            const scoped_index& xindex2);

  static bool equal(const scoped_index& xindex1,
            const scoped_index& xindex2);
};

class SHEAF_DLL_SPEC equivalence_compare_policy
{
 public:

  static bool less_than(const scoped_index& xindex1,
            const scoped_index& xindex2);

  static bool equal(const scoped_index& xindex1,
            const scoped_index& xindex2);
};

template <typename T = lexographical_compare_policy>
class SHEAF_DLL_SPEC stl_scoped_index
{
  // ===========================================================
  // STL_SCOPED_INDEX FACET
  // ===========================================================

 public:

  typedef T compare_policy;

  stl_scoped_index(const scoped_index& xindex);

  ~stl_scoped_index();

  inline bool invariant() const
  {
    return _index.invariant();
  };

  inline const scoped_index& index() const
  {
    return _index;
  };

  operator scoped_index () const;

  bool operator<(const stl_scoped_index<T>& xother) const;

  bool operator==(const stl_scoped_index<T>& xother) const;

 private:

  scoped_index _index; 
};

} // namespace sheaf

#endif // ifndef STL_SCOPED_INDEX_H