82 lines
2.9 KiB
Rust
82 lines
2.9 KiB
Rust
|
// Global constants across the entirety of TAMER
|
||
|
|
//
|
||
|
|
// Copyright (C) 2014-2019 Ryan Specialty Group, LLC.
|
||
|
|
//
|
||
|
|
// 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 3 of the License, or
|
||
|
|
// (at your option) any later version.
|
||
|
|
//
|
||
|
|
// This program 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 General Public License for more details.
|
||
|
|
//
|
||
|
|
// You should have received a copy of the GNU General Public License
|
||
|
|
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||
|
|
|
||
|
|
//! System-wide static configuration.
|
||
|
|
//!
|
||
|
|
//! This module provides a system-wide configuration.
|
||
|
|
//! Subsystems should reference these values rather than defining their own
|
||
|
|
//! and risk incompatibilities or maintenance issues as requirements
|
||
|
|
//! change.
|
||
|
|
//!
|
||
|
|
//! By convention,
|
||
|
|
//! import this entire module rather than individual members and reference
|
||
|
|
//! them as `global::foo` to emphasize their nature and risk.
|
||
|
|
|
||
|
|
use std::num;
|
||
|
|
|
||
|
|
/// A size capable of representing every interned string in a package.
|
||
|
|
pub type PkgSymSize = u16;
|
||
|
|
|
||
|
|
/// A non-zero equivalent of [`PkgSymSize`];
|
||
|
|
pub type NonZeroPkgSymSize = num::NonZeroU16;
|
||
|
|
|
||
|
|
/// A size capable of representing every interned string in a program.
|
||
|
|
pub type ProgSymSize = u32;
|
||
|
|
|
||
|
|
/// A non-zero equivalent of [`ProgSymSize`];
|
||
|
|
pub type NonZeroProgSymSize = num::NonZeroU32;
|
||
|
|
|
||
|
|
/// A size capable of representing indexes of each individual identifier
|
||
|
|
/// within a single package.
|
||
|
|
///
|
||
|
|
/// Note that,
|
||
|
|
/// since TAME is a metalanguage and can easily expand into a great
|
||
|
|
/// deal of code,
|
||
|
|
/// this must accommodate far more than the user's expectations
|
||
|
|
/// working within the provided level of abstraction.
|
||
|
|
///
|
||
|
|
/// This must be ≥ [`PkgSymSize`].
|
||
|
|
pub type PkgIdentSize = u16;
|
||
|
|
|
||
|
|
/// A size capable of representing every individual identifier and
|
||
|
|
/// expression within a single package.
|
||
|
|
///
|
||
|
|
/// Note that,
|
||
|
|
/// since TAME is a metalanguage and can easily expand into a great
|
||
|
|
/// deal of code,
|
||
|
|
/// this must accommodate far more than the user's expectations
|
||
|
|
/// working within the provided level of abstraction.
|
||
|
|
pub type PkgIdentExprSize = u32;
|
||
|
|
|
||
|
|
/// A size capable of representing the union of every identifier of every
|
||
|
|
/// package used by an entire program.
|
||
|
|
///
|
||
|
|
/// This must be ≥ [`ProgSymSize`].
|
||
|
|
pub type ProgIdentSize = u32;
|
||
|
|
|
||
|
|
/// A size capable of representing the union of every identifier and every
|
||
|
|
/// expression of every package used by an entire program.
|
||
|
|
///
|
||
|
|
/// Note that,
|
||
|
|
/// since TAME is a metalanguage and can easily expand into a great
|
||
|
|
/// deal of code,
|
||
|
|
/// this must accommodate far more than the user's expectations
|
||
|
|
/// working within the provided level of abstraction.
|
||
|
|
///
|
||
|
|
/// This must be ≥ [`ProgSymSize`].
|
||
|
|
pub type ProgIdentExprSize = u32;
|