sheaf_constants.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.
//

// Declarations for namespace sheaf_constants

#ifndef SHEAF_CONSTANTS_H
#define SHEAF_CONSTANTS_H

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

#ifndef DOF_TUPLE_TYPE_H
#include "SheafSystem/dof_tuple_type.h"
#endif

#ifndef POSET_TYPE_H
#include "SheafSystem/poset_type.h"
#endif

#ifndef PRIMITIVE_TYPE_H
#include "SheafSystem/primitive_type.h"
#endif

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

#ifndef STANDARD_VERSION_INDEX_H
#include "SheafSystem/standard_version_index.h"
#endif

#ifndef STD_CSTDDEF_H
#include "SheafSystem/std_cstddef.h"
#endif

#ifndef STD_IOSTREAM_H
#include "SheafSystem/std_iostream.h"
#endif

#ifndef STD_STRING_H
#include "SheafSystem/std_string.h"
#endif

namespace sheaf
{
  
class SHEAF_DLL_SPEC sheaf_constants
{

public:

  // =============================================================================
  // POSET TYPES FACET
  // =============================================================================

  typedef poset_type poset_type;

  static poset_type poset_type_id(int xi);

  // =============================================================================
  // DOF TUPLE TYPES FACET
  // =============================================================================

  typedef dof_tuple_type dof_tuple_type;

  static const string& dof_tuple_type_to_name(dof_tuple_type xdt);

  static dof_tuple_type dof_tuple_type_from_name(const string& xname);

  static dof_tuple_type dof_tuple_type_id(int xi);

  // =============================================================================
  // VERSION IDENTIFIERS FACET
  // =============================================================================

  static const int NOT_A_VERSION();

  static const int COARSEST_COMMON_REFINEMENT_VERSION();

  static const int CURRENT_HOST_VERSION();

  static const int CURRENT_MEMBER_VERSION();

  // =============================================================================
  // STANDARD POSET MEMBERS FACET
  // =============================================================================

  static const scoped_index BOTTOM_INDEX();

  static const scoped_index TOP_INDEX();

  // =============================================================================
  // STANDARD NAMESPACE_POSET MEMBERS FACET
  // =============================================================================

  static const scoped_index PRIMITIVES_SCHEMA_INDEX();

  static const scoped_index NAMESPACE_SCHEMA_INDEX();

  static const scoped_index PRIMITIVES_INDEX();

  static const scoped_index SCHEMA_DEFINITIONS_INDEX();

  // =============================================================================
  // STANDARD SUBPOSETS FACET
  // =============================================================================

  static const scoped_index JIMS_INDEX();

  static const scoped_index WHOLE_INDEX();

  static const scoped_index RESIDENT_INDEX();
  static const scoped_index TOC_INDEX();

  // =============================================================================
  // STANDARD DOF TUPLES FACET
  // =============================================================================

  static const scoped_index EMPTY_DOF_TUPLE_INDEX();



  // =============================================================================
  // PRIMITIVE TYPES FACET
  // =============================================================================

  typedef primitive_type primitive_type;

  static string primitive_type_to_name(primitive_type xpt);

  static primitive_type primitive_type_from_name(const string& xname);

  static primitive_type primitive_type_from_index(int xindex);

  static bool is_primitive_index(int xindex);

  // =============================================================================
  // PRIMITIVE DESCRIPTORS FACET
  // =============================================================================

  typedef primitive_descriptor primitive_descriptor;

  static primitive_descriptor primitive_description(int xindex);

  static size_t max_primitive_size();

  static size_t align(const size_t xoffset, const size_t xalignment);

  // =============================================================================
  // UTILITY METHODS FACET
  // =============================================================================

  static void check_lps_script_has_run();

};

} // namespace sheaf


#endif // ifndef SHEAF_CONSTANTS_H