FileStream Class Reference

#include <C:/adskgit/3dsmax/3dsmax/3dswin/src/maxsdk/include/maxscript/foundation/FileStream.h>

Inheritance diagram for FileStream:

Public Member Functions
ScripterExport	FileStream ()
	~FileStream ()
	classof_methods (FileStream, CharStream)
void	collect () override
void	gc_trace () override
void	sprin1 (CharStream *s) override
	def_visible_generic_debug_ok (read_value, "readValue")
	def_visible_generic_debug_ok (read_expr, "readExpr")
	def_visible_generic_debug_ok (read_line, "readLine")
	def_visible_generic_debug_ok (read_char, "readChar")
	def_visible_generic_debug_ok (read_chars, "readChars")
	def_visible_generic_debug_ok (read_delimited_string, "readDelimitedString")
	def_visible_generic_debug_ok (skip_to_string, "skipToString")
	def_visible_generic_debug_ok (skip_to_next_line, "skipToNextLine")
	def_visible_generic_debug_ok (execute, "execute")
	def_visible_generic_debug_ok (file_pos, "filepos")
	def_visible_generic_debug_ok (seek, "seek")
	def_visible_generic_debug_ok (eof, "eof")
	def_visible_generic (close, "close")
	def_visible_generic (flush, "flush")
	use_generic (free, "free")
void	seek (int pos) override
ScripterExport FileStream *	open_decrypt (const MCHAR *ifile_name, int seed, unsigned int encoding=-1)
	Open an encrypted text file for read.
ScripterExport FileStream *	open (const MCHAR *ifile_name, const MCHAR *imode, unsigned int encoding=-1)
	Open a text file.
void	log_to (CharStream *pLog) override
void	close_log () override
void	undo_lookahead ()
Public Member Functions inherited from CharBinaryStream
	CharBinaryStream ()
virtual	~CharBinaryStream ()
bool	Open (MaxSDK::Util::BinaryStream *pStream, const MSTR &mode, unsigned int encoding=-1)
	Open a text file.
MaxSDK::Util::Char	get_char () override
void	unget_char (const MaxSDK::Util::Char &c) override
MaxSDK::Util::Char	peek_char () override
int	at_eos () override
void	rewind () override
unsigned int	pos () override
unsigned int	line () override
void	flush () override
void	flush_to_eol () override
MaxSDK::Util::Char	putch (const MaxSDK::Util::Char &c) override
const MCHAR *	puts (const MCHAR *str) override
int	printf (const MCHAR *format,...) override
void	close () override
bool	IsEncrypted () const
void	check_file_is_open () const
void	check_readable () const
void	check_writeable () const
void	check_is_not_eof () const
Public Member Functions inherited from CharStream
ScripterExport	CharStream ()
virtual	~CharStream ()
	classof_methods (CharStream, Value)
BOOL	_is_charstream () override
virtual void	flush_to_eobuf ()
virtual void	flush_whitespace ()
void	puts (const MSTR &str)
virtual Listener *	get_listener ()
virtual CharStream *	get_log ()
virtual Value *	get_file_name ()
virtual void	set_file_name (const MCHAR *fileName)
virtual CharStream *	get_resource_value_stream (Value *resourceID)
Public Member Functions inherited from Value
virtual ScripterExport BOOL	is_kind_of (ValueMetaClass *c)
virtual ScripterExport ValueMetaClass *	local_base_class ()
virtual Value *	eval ()
virtual Value *	eval_no_wrapper ()
virtual ScripterExport Value *	apply (Value **arglist, int count, CallContext *cc=nullptr)
virtual ScripterExport Value *	apply_no_alloc_frame (Value **arglist, int count, CallContext *cc=nullptr)
virtual void	export_to_scripter ()
virtual Value *	map (node_map &m)
virtual Value *	map_path (PathName *path, node_map &m)
virtual Value *	find_first (BOOL(*test_fn)(INode *node, int level, const void *arg), const void *test_arg)
virtual Value *	get_path (PathName *path)
virtual ScripterExport void	sprint (CharStream *stream)
virtual void	prin1 ()
virtual void	print ()
virtual Class_ID	get_max_class_id ()
virtual Value *	delete_vf (Value **arglist, int arg_count)
virtual Value *	clearSelection_vf (Value **arglist, int arg_count)
virtual float	to_float ()
virtual double	to_double ()
virtual const MCHAR *	to_string ()
virtual MSTR	to_mstr ()
virtual MSTR	to_filename ()
virtual int	to_int ()
virtual INT64	to_int64 ()
virtual INT_PTR	to_intptr ()
virtual BOOL	to_bool ()
virtual BitArray &	to_bitarray ()
virtual Point4	to_point4 ()
virtual Point3	to_point3 ()
virtual Point2	to_point2 ()
virtual AColor	to_acolor ()
virtual COLORREF	to_colorref ()
virtual INode *	to_node ()
virtual Ray	to_ray ()
virtual Interval	to_interval ()
virtual Quat	to_quat ()
virtual AngAxis	to_angaxis ()
virtual Matrix3 &	to_matrix3 ()
virtual Box3	to_box3 ()
virtual float *	to_eulerangles ()
virtual Mtl *	to_mtl ()
virtual Texmap *	to_texmap ()
virtual MtlBase *	to_mtlbase ()
virtual Modifier *	to_modifier ()
virtual TimeValue	to_timevalue ()
virtual Control *	to_controller ()
virtual Atmospheric *	to_atmospheric ()
virtual Effect *	to_effect ()
virtual IMultiPassCameraEffect *	to_mpassCamEffect ()
virtual ShadowType *	to_shadowtype ()
virtual FilterKernel *	to_filter ()
virtual INode *	to_rootnode ()
virtual ITrackViewNode *	to_trackviewnode ()
virtual NURBSIndependentPoint *	to_nurbsindependentpoint ()
virtual NURBSPoint *	to_nurbspoint ()
virtual NURBSObject *	to_nurbsobject ()
virtual NURBSControlVertex *	to_nurbscontrolvertex ()
virtual NURBSCurve *	to_nurbscurve ()
virtual NURBSCVCurve *	to_nurbscvcurve ()
virtual NURBSSurface *	to_nurbssurface ()
virtual NURBSTexturePoint *	to_nurbstexturepoint ()
virtual NURBSSet *	to_nurbsset ()
virtual ReferenceTarget *	to_reftarg ()
virtual Mesh *	to_mesh ()
virtual BezierShape *	to_beziershape ()
virtual Thunk *	to_thunk ()
virtual void	to_fpvalue (FPValue &v)
virtual Renderer *	to_renderer ()
virtual Box2 &	to_box2 ()
virtual NURBSTextureSurface *	to_nurbstexturesurface ()
virtual NURBSDisplay *	to_nurbsdisplay ()
virtual TessApprox *	to_tessapprox ()
virtual Value *	widen_to (Value *arg, Value **arg_list)
virtual BOOL	comparable (Value *arg)
virtual BOOL	special_case_compare (Value *arg, bool &specialCaseCompareResult)
virtual ScripterExport bool	ValuesEqual (Value *other, bool strictCompare)
virtual ScripterExport Value *	deep_copy (HashTable *remapper)
virtual BOOL	is_const ()
virtual ScripterExport Value *	get_property (Value **arg_list, int count)
virtual ScripterExport Value *	set_property (Value **arg_list, int count)
ScripterExport Value *	_get_property (Value *prop)
virtual ScripterExport Value *	_set_property (Value *prop, Value *val)
virtual Value *	get_container_property (Value *prop, Value *cur_prop)
virtual Value *	set_container_property (Value *prop, Value *val, Value *cur_prop)
virtual BOOL	_is_collection ()
virtual BOOL	_is_rolloutcontrol ()
virtual BOOL	_is_rolloutthunk ()
virtual BOOL	_is_function ()
virtual BOOL	_is_selection ()
virtual BOOL	_is_thunk ()
virtual BOOL	_is_indirect_thunk ()
virtual SelectionIterator *	selection_iterator ()
virtual ScripterExport IOResult	Save (ISave *isave)
virtual void	drop_MAX_refs ()
virtual BaseInterface *	GetInterface (Interface_ID id)
ScripterExport Value *	make_heap_permanent ()
ScripterExport Value *	make_heap_static ()
ScripterExport Value *	get_heap_ptr ()
ScripterExport Value *	get_stack_heap_ptr ()
ScripterExport Value *	migrate_to_heap ()
ScripterExport Value *	get_live_ptr ()
virtual BOOL	object_supports_case_sensitive_names ()
ScripterExport Value *	_get_property (Value *prop, Value *prop_name_as_parsed)
ScripterExport Value *	_set_property (Value *prop, Value *val, Value *prop_name_as_parsed)
virtual ScripterExport Value *	get_case_sensitive_property (Value **arg_list, int count, const TCHAR *case_sensitive_name)
virtual ScripterExport Value *	set_case_sensitive_property (Value **arg_list, int count, const TCHAR *case_sensitive_name)
ScripterExport Value *	invoke_getter_case_sensitive_property (Value *target, getter_vf getter, Value **arg_list, int count, const TCHAR *case_sensitive_name, const TCHAR *nested_prop_case_sensitive_name)
ScripterExport Value *	invoke_setter_case_sensitive_property (Value *target, setter_vf setter, Value **arg_list, int count, const TCHAR *case_sensitive_name, const TCHAR *nested_prop_case_sensitive_name)
Public Member Functions inherited from Collectable
ScripterExport	Collectable ()
virtual ScripterExport	~Collectable ()
ScripterExport void *	operator new (size_t sz, char flag)
ScripterExport void *	operator new (size_t sz)
ScripterExport void	operator delete (void *val)
ScripterExport void	operator delete (void *val, char flag)
ScripterExport bool	derives_from_Animatable ()
virtual BOOL	derives_from_MAXWrapper ()
ScripterExport void	make_collectable ()
void	make_permanent ()
void	make_static ()
int	is_marked ()
int	is_not_marked ()
int	is_garbage ()
int	is_permanent ()
void	mark_in_use ()
void	unmark_in_use ()
int	has_heap_copy ()
int	is_in_heap ()
int	is_on_stack ()

Public Attributes
MSTR	mode
CharStream *	log
Parser *	reader
Public Attributes inherited from Value
ValueMetaClass *	tag
Public Attributes inherited from Collectable
Collectable *	next
Collectable *	prev
byte	flags
byte	flags2
short	flags3

Protected Member Functions
void	ThrowNotOpenedError () const override
MaxSDK::Util::BinaryStream *	OpenStream (const MCHAR *fn, const MSTR &_mode)
Protected Member Functions inherited from CharBinaryStream
virtual void	ThrowNotReadableError () const
virtual void	ThrowNotWritableError () const
virtual void	ThrowReachEOFError () const

Additional Inherited Members
Static Public Member Functions inherited from Collectable
static ScripterExport void	for_all_values (void(*map_fn)(Value *val), ValueMapper *mapper=nullptr, ValueMetaClass *c=nullptr)
static void	mark ()
static void	sweep ()
static void	setup (size_t)
static ScripterExport void	gc ()
static void	coalesce_free_list ()
static void	close_down ()
static void	drop_maxwrapper_refs ()
static ScripterExport void	push_alloc_stack_frame ()
static ScripterExport void	pop_alloc_stack_frame ()
static ScripterExport ULONGLONG	get_num_values_created ()
static ScripterExport bool	validate_value_linkages ()
Static Public Attributes inherited from Collectable
static CRITICAL_SECTION	heap_update
static Collectable *	collectable_list
static Collectable *	permanent_list
static free_mem *	free_list [GC_NUM_SUBLISTS]
static size_t	heap_allocated
static size_t	heap_size
static ScripterExport collectable_state	state
static ScripterExport bool	fullCollectNextHoldFlush
static bool	gc_light
static bool	in_gc
static HANDLE	hGCCompletedEvent
Protected Attributes inherited from CharBinaryStream
MaxSDK::Util::BinaryStream *	stream
MaxSDK::Util::TextFile::BaseTextReader *	textReader
MaxSDK::Util::TextFile::BaseTextWriter *	textWriter
Protected Attributes inherited from CharStream
unsigned int	mlineNumber
Value *	file_name
HashTable *	resourceMap
StringStream *	resourceValueStream
Static Protected Attributes inherited from Value
static ScripterExport Value *	keyarg_marker_value

Constructor & Destructor Documentation

FileStream()

ScripterExport FileStream

(

)

~FileStream()

~FileStream

(

)

Member Function Documentation

classof_methods()

classof_methods	(	FileStream	,
		CharStream	)

collect()

void collect ( )

overridevirtual

Implements Collectable.

gc_trace()

void gc_trace ( )

overridevirtual

Reimplemented from CharStream.

sprin1()

void sprin1 ( CharStream * s )

overridevirtual

Reimplemented from Value.

def_visible_generic_debug_ok() [1/12]

def_visible_generic_debug_ok	(	read_value	,
		"readValue"	)

def_visible_generic_debug_ok() [2/12]

def_visible_generic_debug_ok	(	read_expr	,
		"readExpr"	)

def_visible_generic_debug_ok() [3/12]

def_visible_generic_debug_ok	(	read_line	,
		"readLine"	)

def_visible_generic_debug_ok() [4/12]

def_visible_generic_debug_ok	(	read_char	,
		"readChar"	)

def_visible_generic_debug_ok() [5/12]

def_visible_generic_debug_ok	(	read_chars	,
		"readChars"	)

def_visible_generic_debug_ok() [6/12]

def_visible_generic_debug_ok	(	read_delimited_string	,
		"readDelimitedString"	)

def_visible_generic_debug_ok() [7/12]

def_visible_generic_debug_ok	(	skip_to_string	,
		"skipToString"	)

def_visible_generic_debug_ok() [8/12]

def_visible_generic_debug_ok	(	skip_to_next_line	,
		"skipToNextLine"	)

def_visible_generic_debug_ok() [9/12]

def_visible_generic_debug_ok	(	execute	,
		"execute"	)

def_visible_generic_debug_ok() [10/12]

def_visible_generic_debug_ok	(	file_pos	,
		"filepos"	)

def_visible_generic_debug_ok() [11/12]

def_visible_generic_debug_ok	(	seek	,
		"seek"	)

def_visible_generic_debug_ok() [12/12]

def_visible_generic_debug_ok	(	eof	,
		"eof"	)

def_visible_generic() [1/2]

def_visible_generic	(	close	,
		"close"	)

def_visible_generic() [2/2]

def_visible_generic	(	flush	,
		"flush"	)

use_generic()

use_generic	(	free	,
		"free"	)

seek()

void seek ( int pos )

overridevirtual

Reimplemented from CharBinaryStream.

open_decrypt()

ScripterExport FileStream * open_decrypt	(	const MCHAR *	ifile_name,
		int	seed,
		unsigned int	encoding = -1 )

Open an encrypted text file for read.

Parameters

[in]	ifile_name	The file name.
[in]	seed	The seed encryption value.
[in]	encoding	The encoding to use if if can not be determined from the file contents, If -1, a default encoding based on the file language settings in Preference /Files (exposed through Interface14) will be used.

Returns

The FileStream instance itself if max is able to open the file or undefined if it fails.

open()

ScripterExport FileStream * open	(	const MCHAR *	ifile_name,
		const MCHAR *	imode,
		unsigned int	encoding = -1 )

Open a text file.

Parameters

[in]	ifile_name	The file name.
[in]	imode	The file open mode. See the MAXScript Help file, topic FileStream Values, for a description of the mode string values.
[in]	encoding	The encoding to use if if can not be determined from the file contents, If -1, a default encoding based on the file language settings in Preference /Files (exposed through Interface14) will be used.

Returns

The FileStream instance itself if max is able to open the file or undefined if it fails.

log_to()

void log_to ( CharStream * pLog )

overridevirtual

Reimplemented from CharStream.

close_log()

void close_log ( )

overridevirtual

Reimplemented from CharStream.

undo_lookahead()

void undo_lookahead

(

)

ThrowNotOpenedError()

void ThrowNotOpenedError ( ) const

overrideprotectedvirtual

Reimplemented from CharBinaryStream.

OpenStream()

MaxSDK::Util::BinaryStream * OpenStream ( const MCHAR * fn, const MSTR & _mode )

protected

Member Data Documentation

mode

MSTR mode

log

CharStream* log

reader

Parser* reader