/**
	\file "Object/devel_switches.h"
	Module-wide preprocessor conditionals.
	Use of this file (ideally) should be confined to the Object directory.  

	The sole purpose of this file is to provide a convenient
	place to include developer switches.  
	During development, it is often desirable to switch back and forth
	between two implementations and versions, controlled by a single
	preprocessor definition.  
	However, in production code, this file should be EMPTY, 
	and NO translation unit should depend on this i.e. do not include.  
	$Id: devel_switches.h,v 1.51 2008/03/17 23:02:18 fang Exp $
 */

#ifndef	__HAC_OBJECT_DEVEL_SWITCHES_H__
#define	__HAC_OBJECT_DEVEL_SWITCHES_H__

// if we want project-wide switches
#if 0
#include "common/devel_switches.h"
#endif

// leave this error enabled for released code
#if 0
#error	Production code should NOT include this header file.  \
	However, if you are developing, use this file as you see fit.  
#endif

//=============================================================================
// define your module-wide development switches here:

/**
	TODO: decide policy for handling relaxed type actuals.  
	Define to 1 to finish implementation of relaxed parameters, 
	whereby partial template parameters may be established
	in a second phase through connections.  
	Goal: 1
	Priority: medium
	Status: complete and tested
		(as of 00-01-04-main-00-81-40-merged-template-02-28)
	Notes: will need mechanism similar to port-summaries to 
		pass pre-determined port parameters up the instance hierarchy.
 */
#define	ENABLE_RELAXED_TEMPLATE_PARAMETERS		1

/**
	Define to 0 to remove formal instance management (template, port)
	from the main body of sequential unrolling.  
	Rationale: remove duplicates
	Goal: 0
	Status: applied to templates, haven't applied to ports yet
	Priority: low (if it ain't broke...), matter of consistency
 */
#define	SEQUENTIAL_SCOPE_INCLUDES_FORMALS	0

/**
	Define to 1 to use dynamic_meta_index_list instead of
	abstract meta_index_list, again because we don't need
	compile-time static analysis anymore.
	Goal: 1
	Status: not begun
	Priority: low
	NOTE: can also replace const_param_expr_list-pointers with
	non-pointers to reduce heap-allocations.  
 */
#define	ALWAYS_USE_DYNAMIC_INDEX_LIST		0

/**
	Define to 1 to allow the parse_context class to support 
	nested outstanding definitions.  
	Useful for allowing top-level scope to be considered a
	definition, where module <= process_definition.  
	Also allows future support for nested definitions. 
	Goal: 1
	Status: perm'd (00-01-04-main-00-81-81)
#define	SUPPORT_NESTED_DEFINITIONS	1
 */

/**
	Define to 1 to introduce and use dense formal value collections.
	Not critical since they are not replicated much, 
	may help performance in lookup a bit, save a little memory
	from sparse structures.  
	Goal: 1
	Status: not begun
	Priority: low, not memory critical
 */
#define	DENSE_FORMAL_VALUE_COLLECTIONS		0

//- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
/**
	Define to 1 to remove super_instance pointers from 
	instance_collection_base, and push them down to 
	port_actual_collections only.  
	Rationale: to save some memory on structures that don't need it.  
	Goal: 1?
	Status: not begun
	Priority: low, slightly memory critical
 */
#define	SUPER_INSTANCES_IN_ACTUALS_ONLY		0

/**
	Define to 1 to pool-allocate collection pool bundles.
	Goal: 1
	Status: not begun
	Priority: low, non-critical enhancement
 */
#define	POOL_ALLOCATE_COLLECTION_POOL_BUNDLES		0

/**
	Define to 1 to pool-allocate footprints. 
	Prerequisite: Depends on footprints being heap-allocated, of course
	Rationale: faster heap allocation, of course.  
	Goal: 1
	Status: not begun
	Priority: low (enhancement, non-critical)
 */
#define	POOL_ALLOCATE_FOOTPRINTS		0

/**
	Define to 1 to use footprint sub-types, distinguishing between
	process, datastruct, and channel footprints.  
	Currently footprint is generic union of needed features, bloated.  
	Rationale: memory reduction and stronger static typing.  
	Goal: ?
	Priority: low
 */
#define	SUBTYPE_FOOTPRINTS			0

/**
	Define to 1 to instantiate struct collections and references, 
	which as of the time of writing this, have never been well-defined
	or used.  
	Goal: ?
	Pending: well-defined semantics in language
 */
#define	ENABLE_DATASTRUCTS			0

/**
	Define to 1 to re-define global_entry<channel> using
	canonical_fundamental_channel footprints.  
	Also allocate ChannelData accordingly.  
	Goal: 1
	Status: done
	Priority: high (for chpsim)
 */
#define	BUILTIN_CHANNEL_FOOTPRINTS		1

/**
	Define 1 to support shared channels in connection checking.
	Rationale: to allow processes with mutually exclusive 
	uses of channels to connect to the same channel.  
	Defect: how do we annotate bidirectional shared?  Omit for now.
	Goal: 1
	Status: done, tested, perm later
	Priority: med-high
 */
#define ENABLE_SHARED_CHANNELS			1

/**
	Define to 1 to generalize CHP attributes in 
	intermediate representation.
	Rationale: currently CHP actions have one hard-coded delay attribute.
	Goal: 1
	Priority: low (not needed before graduation)
 */
#define	CHP_GENERAL_ATTRIBUTES			0

/**
	Define to 1 to make use of a forgiving type.  
	Rationale: With the advent of run-time bound functions, we can no longer
	make static type guarantees about functions, so we need to 
	accommdate late type bindings with the help of a forgiving
	type lattice element, the match-all-data-type.  
	For type checking purposes, this matches all.  
	Goal: 1?
	Status: done, tested
	Priority: high -- for chpsim function support
 */
#define	USE_TOP_DATA_TYPE			1

/**
	New experimental hack to print worst-case, best-case conductances
	of production rules, currently only available in hflat.
	Rationale: strength checking vs. post-extraction load
	Goal: 1?
	Status: done, basically tested
	Priority: high
 */
#define	CFLAT_WITH_CONDUCTANCES			1

//- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
/**
	Define to 1 to construct one canonical process event subgraph per
	complete type (with CHP) to make allocation easier, and faster.
	Also makes events per process contiguous in allocation, making
	reverse-mapping much easier.  
	Status: Completed and perm'd: main-00-81-68-chpsim-09 branch
#define	LOCAL_CHP_EVENT_FOOTPRINT		1
**/

// Idea: regenerate CHP event footprint upon load as an alternative to
// storing in object file?  Perhaps leave as command-line option.  

//- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// these flags affect actions in parser/hackt-parse.yy.in
/**
	Define to 1 to treat user-defined channels like processes, 
	in that they have subinstances, can be instantiated with their
	members, and are processed through cflat.  
	Type-checking? instances? built-in channel types?
	Connection between built-in channel types and user-defined
	will NOT work yet.
	THIS COULD BE HIGHLY INVASIVE.
	Rationale: so that certain unnamed parties can use defchans
		like processes in the f'd up shadow toolchain...
	Goal: ?
	Priority: damn it
	Resolution: try to hack the parser -- success!
		Parser treats defchan decls like process, rest of middle-end
		and type-checking is unchanged.  
	Status: done, tested minimally
	Afterthought: this feels really really dirty...
 */
#define	DEFCHAN_LIKE_PROCESS			1

/**
	Same idea as above.  
	This still feels dirty, but that's the way some like it.
 */
#define	DEFTYPE_LIKE_PROCESS			1

//- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// ACT compatbility switches
/**
	Define to 1 to require definitions to be exported to 
	be usable outside their home namespace.  
	Note: does not apply to typedefs.  
	Goal: 1
	Rationale: ACT-compatibility
	Status: completed, tested
 */
#define	REQUIRE_DEFINITION_EXPORT		1

//- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// the below flags are done, revisit and perm them later

/**
	Define to 1 recurse collection of port aliases (redundantly redundant)
	Discovered that using instance_collection_pool_manager to collect
	instance aliases results in massive redundant repetition in
	footprint's scope_aliases (which is never dumper, incidentally).
	Disabling this behavior should result in smaller footprints.  
	Goal: ?
	Status: 1 (original)
	Resolution: we keep recursion for now, and revisit this later.  
 */
#define	RECURSE_COLLECT_ALIASES			1

/**
	Simplify implementation of collecting port aliases
	by collecting over scope-aliases in a separate pass.  
	Status: perm'd
#define	COPY_IF_PORT_ALIASES			1
**/

/**
	Define to 1 to not serialize scope-alias summaries, but rather
	regenerate/recache them automatically and on-demand.  
	With this on, they are reconstructed upon footprint::load.  
	This cut the size of the object binaries, by reconstructing
		redundant (precisely regenerable) information.  
	Goal: 1? (probably)
	Priority: low-medium (memory intensive)
	Status: done, tested, but not perm'd yet.  
		Results in massive (factor of 2) savings on 
		large objects, especially top-level hierarchy.
 */
#define	AUTO_CACHE_FOOTPRINT_SCOPE_ALIASES		1

//=============================================================================

#endif	// __HAC_OBJECT_DEVEL_SWITCHES_H__

