definitions.h File Reference

Constants and objects used throughout HOOPLE. More...

Go to the source code of this file.

Classes

class  basis::root_object
 < Number of bytes in a terabyte. More...

Namespaces

namespace  basis
 

The guards collection helps in testing preconditions and reporting errors.


Defines

#define NIL   0
 The value representing a pointer to nothing, or nothing itself.
#define BITS_PER_BYTE   8
 A fundamental constant measuring the number of bits in a byte.
#define PI_APPROX   3.14159265358
 An approximation of the fundamental circular constant.
#define formal(parameter)
 This macro just eats what it's passed; it marks unused formal parameters.
#define MININT32   0x80000000
 Maximum 32-bit integer value.
#define MAXINT16   0x7fff
 Maximum 32-bit integer value.
#define MININT16   0x8000
 Minimum 32-bit integer value.
#define MAXCHAR   0x7f
 Maximum byte-based character value.
#define MINCHAR   0x80
 Minimum byte-based character value.
#define MAXBYTE   0xff
 Maximum unsigned byte value.
#define MINBYTE   0x00
 Minimum unsigned byte value.

Typedefs

typedef unsigned char basis::abyte
 A fairly important unit which is seldom defined...
typedef char basis::flexichar
typedef unsigned int basis::un_int
 Abbreviated name for unsigned integers.
typedef unsigned short basis::un_short
 Abbreviated name for unsigned short integers.
typedef unsigned long basis::un_long
 Abbreviated name for unsigned long integers.
typedef char basis::int8
typedef unsigned char basis::uint8
typedef signed short basis::int16
typedef unsigned short basis::uint16
typedef signed int basis::int32
typedef unsigned int basis::uint32

Variables

const int basis::SECOND_ms = 1000
 Number of milliseconds in a second.
const int basis::MINUTE_ms = 60 * SECOND_ms
 Number of milliseconds in a minute.
const int basis::HOUR_ms = 60 * MINUTE_ms
 Number of milliseconds in an hour.
const int basis::DAY_ms = 24 * HOUR_ms
 Number of milliseconds in a day.
const int basis::MINUTE_s = 60
 Number of seconds in a minute.
const int basis::HOUR_s = 60 * MINUTE_s
 Number of seconds in an hour.
const int basis::DAY_s = 24 * HOUR_s
 Number of seconds in a day.
const int basis::KILOBYTE = 1024
 Number of bytes in a kilobyte.
const int basis::MEGABYTE = KILOBYTE * KILOBYTE
 Number of bytes in a megabyte.
const int basis::GIGABYTE = MEGABYTE * KILOBYTE
 Number of bytes in a gigabyte.
const double basis::TERABYTE = double(GIGABYTE) * double(KILOBYTE)

Detailed Description

Constants and objects used throughout HOOPLE.

Defines a set of useful universal constants (for our chosen universe) and a set of aliases for convenient abstract and concrete data types. This is the lowest-level header in hoople and should not include any others.

Definition in file definitions.h.


Define Documentation

#define BITS_PER_BYTE   8
#define formal ( parameter   ) 

This macro just eats what it's passed; it marks unused formal parameters.

Definition at line 45 of file definitions.h.

#define MAXBYTE   0xff

Maximum unsigned byte value.

Definition at line 107 of file definitions.h.

#define MAXCHAR   0x7f

Maximum byte-based character value.

Definition at line 99 of file definitions.h.

#define MAXINT16   0x7fff

Maximum 32-bit integer value.

Definition at line 91 of file definitions.h.

#define MINBYTE   0x00

Minimum unsigned byte value.

Definition at line 111 of file definitions.h.

#define MINCHAR   0x80

Minimum byte-based character value.

Definition at line 103 of file definitions.h.

#define MININT16   0x8000

Minimum 32-bit integer value.

Definition at line 95 of file definitions.h.

#define MININT32   0x80000000

Maximum 32-bit integer value.

Minimum 32-bit integer value.

Definition at line 87 of file definitions.h.

#define NIL   0

The value representing a pointer to nothing, or nothing itself.

Definition at line 32 of file definitions.h.

Referenced by structures::static_memory_gremlin::__hoople_globals(), sockets::spocket::accept(), filesystem::directory_tree::access(), structures::hash_table< key_type, contents >::acquire(), octopi::entity_data_bin::acquire_for_any(), octopi::entity_data_bin::acquire_for_entity(), octopi::entity_data_bin::acquire_for_identifier(), filesystem::directory_tree::add_path(), loggers::critical_events::alert_message(), structures::amorph< contents >::append(), configuration::application_configuration::application_name(), cromp::cromp_client::asynch_connect(), octopi::tentacle::attach_storage(), structures::amorph< contents >::borrow(), nodes::tree::branch(), processes::launch_process::break_line(), synchronic::list_manager::clone_object(), filesystem::byte_filer::close(), application::stdio_redirecter::close_input(), basis::array< contents >::concatenation(), sockets::spocket::connect(), application::create_simplistic_window(), crypto::blowfish_crypto::decrypt(), cromp::cromp_client::decrypt_package_as_needed(), octopi::tentacle::detach_storage(), cromp::cromp_server::enable_servers(), crypto::blowfish_crypto::encrypt(), structures::static_memory_gremlin::ensure_space_exists(), octopi::octopus::evaluate(), menu_base::evaluate_trigger(), octopi::file_transfer_tentacle::file_transfer_tentacle(), structures::symbol_table< contents >::find(), structures::static_memory_gremlin::find(), structures::hash_table< key_type, contents >::find(), structures::hash_table< void *, internal_pointer_hider< basis::astring > >::find(), structures::amorph< contents >::find(), filesystem::filename_list::find(), configuration::configuration_list::find(), crypto::rsa_crypto::generate_key(), structures::static_memory_gremlin::get(), menu_base::get_item(), nodes::node::get_link(), versions::version_checker::get_record(), menu_base::get_submenu(), processes::thread_cabinet::get_thread(), nodes::tree::insert(), structures::set< contents >::intersection(), sockets::internet_address::is_valid_internet_address(), application::launch_manager::launch_manager(), octopi::key_repository::lock(), octopi::file_transfer_tentacle::lock_directory(), sockets::socket_minder::lock_socket_data(), octopi::octopus::lock_tentacle(), main(), nodes::tree::iterator::next(), octopi::tentacle::next_request(), filesystem::byte_filer::open(), nodes::path::pop(), bookmark_tree::process_category(), octopi::tentacle::propel_arm(), nodes::tree::prune_index(), octopi::login_tentacle::reconstitute(), octopi::file_transfer_tentacle::reconstitute(), octopi::unwrapping_tentacle::reconstitute(), octopi::encryption_tentacle::reconstitute(), octopi::tentacle_helper< unhandled_request >::reconstitute(), octopi::identity_tentacle::reconstitute(), nodes::packable_tree::recursive_pack(), nodes::packable_tree::recursive_packed_size(), nodes::packable_tree::recursive_unpack(), processes::post_office::register_route(), nodes::list::remove(), filesystem::directory_tree::remove_path(), octopi::octopus::remove_tentacle(), processes::rendezvous::rendezvous(), basis::array< contents >::resize(), octopi::octopus::restore(), versions::version_checker::retrieve_version(), processes::launch_process::run(), filesystem::directory_tree::seek(), sockets::raw_socket::select(), loggers::program_wide_logger::set(), crypto::rsa_crypto::set_key(), sockets::socket_minder::socket_minder(), application::stdio_redirecter::std_thread_action(), textual::string_manipulation::string_to_hex(), basis::array< contents >::subarray(), cromp::cromp_client::synchronous_request(), loggers::critical_events::system_error_text(), timely::timer_driver::timer_driver(), nodes::tree::tree(), octopi::octopus::unlock_tentacle(), structures::unpack_array(), structures::unpack_simple(), basis::WHACK(), cromp::cromp_server::wrap_infoton(), application::stdio_redirecter::write(), application::stdio_redirecter::zap_program(), octopi::octopus::zap_tentacle(), basis::array< contents >::~array(), basis::astring::~astring(), cromp::cromp_common::~cromp_common(), cromp::cromp_server::~cromp_server(), octopi::infoton_id_pair::~infoton_id_pair(), processes::rendezvous::~rendezvous(), application::shared_memory::~shared_memory(), structures::static_memory_gremlin::~static_memory_gremlin(), and timely::timer_driver::~timer_driver().

#define PI_APPROX   3.14159265358

An approximation of the fundamental circular constant.

Definition at line 38 of file definitions.h.

Referenced by geometric::ellipse::area(), geometric::circle::area(), geometric::circle::circumference(), geometric::circle::dimensions(), and geometric::ellipse::perimeter().

Generated on Sat Jan 28 04:23:14 2012 for hoople2 project by  doxygen 1.6.3