hoc.h File Reference

#include "hocassrt.h"
#include <string.h>
#include "redef.h"

Include dependency graph for hoc.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
union	Inst
struct	Arrayinfo
struct	Proc
struct	Symlist
struct	HocSymExtension
struct	Symbol
union	Datum
struct	IntFunc
struct	DoubScal
struct	DoubVec
struct	HocParmLimits
struct	HocStateTolerance
struct	HocParmUnits
Defines
#define	INCLUDEHOCH   1
#define	OOP   1
#define	HocStruct   struct
#define	HocUnion   union
#define	HocTypedef   typedef
#define	STOP   (Inst *)0
#define	NOTUSER   0
#define	USERINT   1
#define	USERDOUBLE   2
#define	USERPROPERTY   3
#define	USERFLOAT   4
#define	SYMBOL   7
#define	OBJECTTMP   8
#define	CPLUSOBJECT   16
#define	JAVAOBJECT   32
#define	OBJECTALIAS   1
#define	VARALIAS   2
#define	ISARRAY(arg)   (arg->arayinfo != (Arrayinfo *)0)
#define	List   hoc_List
#define	Item   hoc_Item
#define	emalloc(arg)   hoc_Emalloc(arg), hoc_malchk()
#define	ecalloc(arg1, arg2)   hoc_Ecalloc(arg1,arg2), hoc_malchk()
#define	erealloc(arg1, arg2)   hoc_Erealloc(arg1,arg2), hoc_malchk()
#define	OPVAL(sym)   hoc_objectdata[sym->u.oboff].pval
#define	OPSTR(sym)   hoc_objectdata[sym->u.oboff].ppstr
#define	OPOBJ(sym)   hoc_objectdata[sym->u.oboff].pobj
#define	OPSECITM(sym)   hoc_objectdata[sym->u.oboff].psecitm
#define	OPLIST(sym)   hoc_objectdata[sym->u.oboff].plist
#define	OPARINFO(sym)   hoc_objectdata[sym->u.oboff + 1].arayinfo
#define	IGNORE(arg)   arg
#define	LINTUSE(arg)
#define	Strcat   strcat
#define	Strncat   strncat
#define	Strcpy   strcpy
#define	Strncpy   strncpy
#define	Sprintf   sprintf
#define	Printf   printf
#define	Fprintf   fprintf
#define	ERRCHK(c1)   c1
#define	IFGUI   if (hoc_usegui){
#define	ENDGUI   }
#define	NOT_PARALLEL_SUB(c1)   {if (!parallel_sub) c1}
Typedefs
typedef int(*	Pfri )()
typedef double(*	Pfrd )()
typedef struct Object **(*	Pfro )()
typedef char **(*	Pfrs )()
typedef union Inst	Inst
typedef struct Arrayinfo	Arrayinfo
typedef struct Proc	Proc
typedef struct Symlist	Symlist
typedef char *	Upoint
typedef struct HocSymExtension	HocSymExtension
typedef struct Symbol	Symbol
typedef struct hoc_Item	hoc_List
typedef union Datum	Datum
Functions
Symbol *	install ()
Symbol **	lookup ()
double	xpop ()
Symbol *	spop ()
double *	getarg ()
char *	gargstr ()
void *	nrn_cacheline_alloc (void **memptr, size_t size)
void *	nrn_cacheline_calloc (void **memptr, size_t nmemb, size_t size)
char *	hoc_Emalloc ()
char **	hoc_Ecalloc ()
char ***	hoc_Erealloc ()
Inst *	Code ()
Objectdata *	hoc_objectdata_save ()
Objectdata *	hoc_objectdata_restore ()
Variables
Inst *	progp
Inst *	progbase
Inst *	prog
Inst *	prog_parse_recover
Inst **	pc
Objectdata *	hoc_objectdata
int	hoc_usegui
int	nrn_istty_
int	parallel_sub

---

Define Documentation

#define CPLUSOBJECT   16

Referenced by call_ob_proc(), class2oc(), hoc_free_allobjects(), hoc_list_allobjref(), hoc_new_object(), hoc_newobj1(), hoc_obj_unref(), and hoc_object_component().

#define ecalloc	(	arg1,
		arg2		)	hoc_Ecalloc(arg1,arg2), hoc_malchk()

Referenced by _hh_reg_(), dep_make(), eqn_space(), fit_praxis(), hoc_last_init(), hoc_newobj1(), hoc_obvar_declare(), hoc_register_tolerance(), hoc_spec_table(), init_access(), neuron2nemo(), node_construct(), nrn_matrix_node_alloc(), and sym_extra_alloc().

#define emalloc

(

arg

)

hoc_Emalloc(arg), hoc_malchk()

Referenced by add_section(), create_point_process(), dep_make(), eqn_space(), fclamp(), fstim(), fsyn(), hoc_arayinfo_install(), hoc_assign_str(), hoc_begintemplate(), hoc_define(), hoc_fmenu(), hoc_getcwd(), hoc_getsym(), hoc_Graph(), hoc_init_space(), hoc_main1(), hoc_name2sym(), hoc_new_object(), hoc_newobj1(), hoc_objvardecl(), hoc_reg_ba(), hoc_symbol_limits(), hoc_symbol_units(), hoc_vsscanf(), hocstr_create(), if(), init(), install(), ion_reg(), neuronhome_forward(), nrn_mk_table_check(), parallel_hoc_main(), prop_alloc(), register_mech(), save_parallel_argv(), save_parallel_envp(), sec_alloc(), SectionRef_reg(), setneuronhome(), stralloc(), and yylex().

#define ENDGUI   }

Referenced by gr_addglyph(), gr_line_info(), Graph_reg(), GrGlyph::GrGlyph(), hoc_help(), hoc_single_event_run(), ivoc_erase_all(), ivoc_gr_begin_line(), ivoc_gr_erase(), ivoc_gr_gif(), ivoc_gr_label(), ivoc_gr_line(), ivoc_gr_mark(), ivoc_gr_menu_remove(), ivoc_gr_menu_tool(), ivoc_gr_size(), ivoc_view_info(), ivoc_view_size(), ivocmain(), nrnallpointmenu(), nrnallsectionmenu(), nrnglobalmechmenu(), nrniv_len_scale(), nrniv_sh_color(), nrniv_sh_color_all(), nrniv_sh_color_list(), nrniv_sh_nearest(), nrniv_sh_observe(), nrniv_sh_push(), nrniv_sh_rotate(), nrnpointmenu(), nrnsecmenu(), and GrGlyph::~GrGlyph().

#define erealloc	(	arg1,
		arg2		)	hoc_Erealloc(arg1,arg2), hoc_malchk()

Referenced by add_nrn_fornetcons(), add_nrn_has_net_event(), batch_save(), hoc_install_object_data_index(), hoc_register_ldifus1(), hoc_resize_toplevel(), hocstr_resize(), KSChan::ion_consist(), ion_reg(), register_mech(), and KSChan::state_consist().

#define ERRCHK

(

c1

)

c1

Referenced by hoc_xopen1(), and wopen().

#define Fprintf   fprintf

Referenced by arayinstal(), emacs_exit(), frame_debug(), hoc_free_symspace(), hoc_last_init(), hoc_main1_init(), moreinput(), neuron2nemo(), nrn_solve(), parallel_hoc_main(), print(), and warning().

#define HocStruct   struct

#define HocTypedef   typedef

#define HocUnion   union

#define IFGUI   if (hoc_usegui){

Referenced by gr_addglyph(), gr_line_info(), Graph_reg(), GrGlyph::GrGlyph(), hoc_help(), hoc_single_event_run(), ivoc_erase_all(), ivoc_gr_begin_line(), ivoc_gr_erase(), ivoc_gr_gif(), ivoc_gr_label(), ivoc_gr_line(), ivoc_gr_mark(), ivoc_gr_menu_remove(), ivoc_gr_menu_tool(), ivoc_gr_size(), ivoc_view_info(), ivoc_view_size(), ivocmain(), nrnallpointmenu(), nrnallsectionmenu(), nrnglobalmechmenu(), nrniv_len_scale(), nrniv_sh_color(), nrniv_sh_color_all(), nrniv_sh_color_list(), nrniv_sh_nearest(), nrniv_sh_observe(), nrniv_sh_push(), nrniv_sh_rotate(), nrnpointmenu(), nrnsecmenu(), and GrGlyph::~GrGlyph().

#define IGNORE

(

arg

)

arg

Referenced by codein(), codesym(), Codraw_plt(), Codraw_preamble(), execerror(), Fig_plt(), follow(), frame_debug(), fsyng(), hardplot_file(), hoc_edit(), hoc_execstr(), hoc_last_init(), hoc_pipeflush(), hoc_sred(), hoc_xopen1(), hplot(), init(), moreinput(), onintr(), plprint(), plt(), register_mech(), ropen(), System(), tplot(), warning(), wopen(), xred(), and yylex().

#define INCLUDEHOCH   1

#define ISARRAY

(

arg

)

(arg->arayinfo != (Arrayinfo *)0)

Referenced by SymDirectoryImpl::append(), assign(), dep_make(), eqinit(), eval(), hoc_araystr(), hoc_array_index(), hoc_evalpointer(), hoc_getsym(), hoc_object_component(), hoc_objectvar(), hoc_parallel_begin(), hoc_register_tolerance(), nrnglobalmechmenu(), set_varble(), shortfor(), steer_point_process(), SymbolItem::SymbolItem(), symbols(), and varread().

#define Item   hoc_Item

Referenced by add_section(), delete_section(), delitems(), forall_section(), forall_sectionlist(), freelist(), hoc_allobjects1(), hoc_allobjects2(), hoc_constobject(), hoc_ifseclist(), hoc_name2obj(), hoc_newobj1(), hoc_obvar_declare(), insertitem(), insertlist(), insertobj(), insertsec(), insertstr(), insertsym(), insertvoid(), SymDirectoryImpl::load_sectionlist(), newlist(), push_section(), and section_exists().

#define JAVAOBJECT   32

Referenced by call_ob_proc(), hoc_new_object(), hoc_newobj1(), hoc_obj_unref(), hoc_object_component(), and java2nrn_class().

#define LINTUSE

(

arg

)

#define List   hoc_List

Referenced by forall_sectionlist(), freelist(), hoc_ifseclist(), SymDirectoryImpl::load_sectionlist(), and newlist().

#define NOT_PARALLEL_SUB

(

c1

)

{if (!parallel_sub) c1}

Referenced by hoc_final_exit(), hoc_obvar_declare(), print(), and PRintf().

#define NOTUSER   0

Referenced by dep_make(), hoc_getsym(), install(), HocDataPathImpl::search(), and varread().

#define OBJECTALIAS   1

Referenced by hoc_free_symspace(), hoc_object_component(), SymbolItem::is_directory(), and SymDirectory::SymDirectory().

#define OBJECTTMP   8

Referenced by eq(), hoc_Argtype(), hoc_is_object_arg(), hoc_is_tempobj_arg(), hoc_newobj(), hoc_obj_look_inside_stack(), hoc_object_asgn(), hoc_objgetarg(), hoc_objpop(), hoc_pop_defer(), hoc_pop_object(), hoc_push_object(), ne(), nopop(), nrnpy_hoc_pop(), prexpr(), and tstkchk_actual().

#define OOP   1

#define OPARINFO

(

sym

)

hoc_objectdata[sym->u.oboff + 1].arayinfo

Referenced by araypt(), dep_make(), eqinit(), hoc_arayinfo_install(), hoc_freearay(), hoc_getsym(), hoc_object_component(), hoc_total_array(), and set_varble().

#define OPLIST

(

sym

)

hoc_objectdata[sym->u.oboff].plist

#define OPOBJ

(

sym

)

hoc_objectdata[sym->u.oboff].pobj

Referenced by hoc_free_symspace(), hoc_object_component(), hoc_objectvar(), and hoc_objvardecl().

#define OPSECITM

(

sym

)

hoc_objectdata[sym->u.oboff].psecitm

Referenced by add_section(), hoc_object_component(), and hoc_obvar_declare().

#define OPSTR

(

sym

)

hoc_objectdata[sym->u.oboff].ppstr

Referenced by hoc_object_component(), hoc_obvar_declare(), hoc_pgargstr(), and hoc_push_string().

#define OPVAL

(

sym

)

hoc_objectdata[sym->u.oboff].pval

Referenced by arayinstal(), assign(), dep_make(), eval(), hoc_evalpointer(), hoc_freearay(), hoc_object_component(), hoc_obvar_declare(), hoc_parallel_begin(), install(), set_varble(), shortfor(), and varread().

#define Printf   printf

Referenced by dashes(), debugzz(), Plot(), print_clamp(), print_stim(), print_syn(), psection(), symbols(), and topology().

#define Sprintf   sprintf

Referenced by hoc_araystr(), hoc_execstr(), hoc_getsym(), hoc_object_name(), hoc_section_pathname(), hoc_xopen1(), ion_reg(), neuron2nemo(), nrnpy_dprop(), prexpr(), prstr(), secname(), sprint(), and System().

#define STOP   (Inst *)0

Referenced by call(), call_ob_proc(), debugzz(), execute(), hoc_call_func(), hoc_define(), hoc_execstr(), hoc_free_symspace(), hoc_get_last_pointer_symbol(), hoc_getsym(), hoc_parse_expr(), and hoc_parse_stmt().

#define Strcat   strcat

#define Strcpy   strcpy

Referenced by hoc_assign_str(), install(), stralloc(), and yylex().

#define Strncat   strncat

#define Strncpy   strncpy

#define SYMBOL   7

Referenced by assign(), eval(), hoc_evalpointer(), hoc_ob_pointer(), hoc_object_asgn(), hoc_object_eval(), hoc_parallel_begin(), hoc_pgargstr(), insertsym(), pushs(), shortfor(), spop(), steer_point_process(), and tstkchk_actual().

#define USERDOUBLE   2

Referenced by assign(), eval(), hoc_evalpointer(), hoc_install_var(), hoc_parallel_begin(), hoc_register_var(), hoc_spinit(), init(), MechanismStandard::MechanismStandard(), nrnallpointmenu(), nrnglobalmechmenu(), HocDataPathImpl::search(), shortfor(), and SymDirectory::variable().

#define USERFLOAT   4

Referenced by assign(), eval(), hoc_evalpointer(), and hoc_spinit().

#define USERINT   1

Referenced by assign(), eval(), hoc_evalpointer(), hoc_spinit(), ipop(), pushi(), shortfor(), and tstkchk_actual().

#define USERPROPERTY   3

Referenced by assign(), eval(), hoc_evalpointer(), hoc_last_init(), hoc_ob_pointer(), hoc_object_asgn(), and hoc_object_eval().

#define VARALIAS   2

Referenced by hoc_free_symspace(), and hoc_object_component().

---

Typedef Documentation

typedef struct Arrayinfo Arrayinfo

typedef union Datum Datum

typedef struct hoc_Item hoc_List

typedef struct HocSymExtension HocSymExtension

typedef union Inst Inst

typedef double(* Pfrd)()

typedef int(* Pfri)()

typedef struct Object**(* Pfro)()

typedef char**(* Pfrs)()

typedef struct Proc Proc

typedef struct Symbol Symbol

typedef struct Symlist Symlist

typedef char* Upoint

---

Function Documentation

Inst * Code

(

)

Type Constraints

char* gargstr

(

)

double* getarg

(

)

char* * hoc_Ecalloc

(

)

Referenced by arayinstal(), nrn_cacheline_calloc(), nrn_prop_data_alloc(), and nrn_prop_datum_alloc().

char* hoc_Emalloc

(

)

Referenced by Codraw_preamble(), hoc_Erealloc(), Matrix_reg(), KSChan::newppsym(), nrn_cacheline_alloc(), nrnisaac_new(), nrnmpi_spike_compress(), and KSChan::setname().

char* * * hoc_Erealloc

(

)

Objectdata* hoc_objectdata_restore

(

)

Referenced by assign(), call(), call_ob_proc(), eval(), hoc_call_objfunc(), hoc_evalpointer(), hoc_iterator_stmt(), hoc_obj_run(), hoc_object_component(), hoc_objectvar(), hoc_push_string(), and nrnpy_pyCallObject().

Objectdata* hoc_objectdata_save

(

)

Referenced by assign(), call(), call_ob_proc(), eval(), hoc_call_objfunc(), hoc_evalpointer(), hoc_iterator_stmt(), hoc_obj_run(), hoc_object_component(), hoc_objectvar(), hoc_push_string(), and nrnpy_pyCallObject().

Symbol* install

(

)

Symbol* * lookup

(

)

void* nrn_cacheline_alloc	(	void **	memptr,
		size_t	size
	)

Referenced by nrn_cacheline_calloc().

void* nrn_cacheline_calloc	(	void **	memptr,
		size_t	nmemb,
		size_t	size
	)

Symbol* spop

(

)

References execerror, Datum::i, SYMBOL, and tstkchk.

double xpop

(

)

References execerror, Datum::i, and tstkchk.

---

Variable Documentation

Objectdata* hoc_objectdata

int hoc_usegui

int nrn_istty_

int parallel_sub

OCSMALL

Referenced by hoc_main1_init(), hoc_parallel_begin(), hoc_parallel_end(), and save_parallel_argv().

Inst * * pc

Inst * prog

Inst * prog_parse_recover

Inst * progbase

Inst* progp