System::IO::TextReader Class Reference

A base class for classes that represent readers that read sequences of characters from different sources. More...

Inherits System::IDisposable.

Inherited by System::IO::StreamReader, and System::IO::StringReader.

Public Member Functions

virtual void Dispose () override
 Releases all resources used by the current object and closes the undelying stream. More...
 
virtual void Close ()
 Closes the stream and releases aquired resources. More...
 
virtual int Peek ()
 
virtual int Read ()
 
virtual int Read (ArrayPtr< char_t > buffer, int index, int count)
 
virtual int ReadBlock (ArrayPtr< char_t > buffer, int index, int count)
 TODO. More...
 
virtual System::String ReadLine ()
 
virtual System::String ReadToEnd ()
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void SharedRefRemoved ()
 Decrements shared reference count and deletes object if it hits zero. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
void FreeOrDetectCycles (int count)
 Reacts on shared reference counter decrement. Shouldn't be called directly, use smart pointers instead. If neccessary, deletes the object. If allowed, initiates loop references lookup. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. TypeInfo structure descibing the type to test current object against. More...
 
void __FreePointers ()
 Resets all smart pointers stored inside this object directly (in fields) or indirectly (in value type fields). Used by memory management systems, shouldn't be called directly. More...
 
virtual void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Protected Member Functions

 TextReader ()
 Constructs a new instance of TextReader. More...
 
virtual void Dispose (bool disposing)
 
- Protected Member Functions inherited from System::Object
virtual shared_members_type GetSharedMembers ()
 Gets list of non-null shared pointers. More...
 
template<class Container , typename Value = typename Container::value_type>
std::enable_if<!System::IsSmartPtr< Value >::value &&!System::detail::is_a< Value, std::pair >::value, void >::type PopulateSharedMembers (Object::shared_members_type &, const char *, Container &)
 
template<class Container , typename Value = typename Container::value_type>
std::enable_if< System::IsSmartPtr< Value >::value, void >::type PopulateSharedMembers (Object::shared_members_type &data, const char *name, Container &container)
 
template<class Container , typename Value = typename Container::value_type>
std::enable_if< System::detail::is_a< Value, std::pair >::value &&!System::IsSmartPtr< typename Value::first_type >::value &&!System::IsSmartPtr< typename Value::second_type >::value, void >::type PopulateSharedMembers (Object::shared_members_type &, const char *, Container &)
 
template<class Container , typename Value = typename Container::value_type>
std::enable_if< System::detail::is_a< Value, std::pair >::value &&System::IsSmartPtr< typename Value::first_type >::value &&!System::IsSmartPtr< typename Value::second_type >::value, void >::type PopulateSharedMembers (Object::shared_members_type &data, const char *name, Container &container)
 
template<class Container , typename Value = typename Container::value_type>
std::enable_if< System::detail::is_a< Value, std::pair >::value &&!System::IsSmartPtr< typename Value::first_type >::value &&System::IsSmartPtr< typename Value::second_type >::value, void >::type PopulateSharedMembers (Object::shared_members_type &data, const char *name, Container &container)
 
template<class Container , typename Value = typename Container::value_type>
std::enable_if< System::detail::is_a< Value, std::pair >::value &&System::IsSmartPtr< typename Value::first_type >::value &&System::IsSmartPtr< typename Value::second_type >::value, void >::type PopulateSharedMembers (Object::shared_members_type &data, const char *name, Container &container)
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 
static void __FreeStaticPointers ()
 Implementation of cleanup_tests option. Deletes shared members of type it is called for. Nothing to delete at this level. More...
 
- Protected Types inherited from System::Object
template<class T >
using supports_free_pointers = decltype(__SupportsFreePointers(std::declval< T * >()))
 Checks if T type supports __FreePointers() method. More...
 
- Static Protected Member Functions inherited from System::Object
template<class T , class Check = decltype(std::declval<T*>()->__FreePointers())>
static std::true_type __SupportsFreePointers (T *)
 Formal function for template magic to check if type T supports __FreePointers() method. More...
 
static std::false_type __SupportsFreePointers (...)
 Formal function for template magic to check if type T supports __FreePointers() method. More...
 
template<class T >
static std::enable_if< supports_free_pointers< T >::value, void >::type __DoFreePointers (T &t)
 
template<class T >
static std::enable_if<!supports_free_pointers< T >::value &&!std::is_fundamental< T >::value &&!std::is_enum< T >::value &&!std::is_const< T >::value, void >::type __DoFreePointers (const T &)
 
template<class T >
static std::enable_if<!supports_free_pointers< T >::value &&!std::is_fundamental< T >::value &&!std::is_enum< T >::value &&std::is_const< T >::value, void >::type __DoFreePointers (T &)
 
template<class T >
static std::enable_if< std::is_fundamental< T >::value||std::is_enum< T >::value, void >::type __DoFreePointers (T)
 

Detailed Description

A base class for classes that represent readers that read sequences of characters from different sources.

Constructor & Destructor Documentation

◆ TextReader()

System::IO::TextReader::TextReader ( )
inlineprotected

Constructs a new instance of TextReader.

Member Function Documentation

◆ Close()

virtual void System::IO::TextReader::Close ( )
inlinevirtual

Closes the stream and releases aquired resources.

Reimplemented in System::IO::StreamReader, and System::IO::StringReader.

◆ Dispose() [1/2]

virtual void System::IO::TextReader::Dispose ( bool  disposing)
inlineprotectedvirtual

Releases all resources used by the current object and closes the undelying stream.

Parameters
disposingSpecifies whether the undelying stream should be closed.

Reimplemented in System::IO::StreamReader, and System::IO::StringReader.

◆ Dispose() [2/2]

virtual void System::IO::TextReader::Dispose ( )
inlineoverridevirtual

Releases all resources used by the current object and closes the undelying stream.

Reimplemented from System::IDisposable.

Reimplemented in System::IO::StringReader.

◆ Peek()

virtual int System::IO::TextReader::Peek ( )
inlinevirtual

Reads a single character from the stream without changing the stream's read cursor.

Returns
Read character encoded with UTF-16 encoding; if the read character is represented by two codepoints in UTF-16 encoding then only the high surragate is returned; if no character was read -1 is returned

Reimplemented in System::IO::StreamReader, and System::IO::StringReader.

◆ Read() [1/2]

virtual int System::IO::TextReader::Read ( )
inlinevirtual

Reads a single character from the stream.

Returns
Read character encoded with UTF-16 encoding; if the read character is represented by two codepoints in UTF-16 encoding then only the high surragate is returned.

Reimplemented in System::IO::StreamReader, and System::IO::StringReader.

◆ Read() [2/2]

virtual int System::IO::TextReader::Read ( ArrayPtr< char_t >  buffer,
int  index,
int  count 
)
virtual

Reads the specified number of characters from the stream and writes them to the specified character array starting at the specified position.

Parameters
bufferThe UTF-16 character array to write the characters read from the stream to
indexA 0-based index in buffer at which to start writing
countThe number of characters to read from the stream
Returns
The number of characters read from the stream

Reimplemented in System::IO::StreamReader, and System::IO::StringReader.

◆ ReadBlock()

virtual int System::IO::TextReader::ReadBlock ( ArrayPtr< char_t >  buffer,
int  index,
int  count 
)
virtual

TODO.

◆ ReadLine()

virtual System::String System::IO::TextReader::ReadLine ( )
virtual

Reads characters from the stream until the end of the current line.

Returns
A string containing the read characters

Reimplemented in System::IO::StreamReader, and System::IO::StringReader.

◆ ReadToEnd()

virtual System::String System::IO::TextReader::ReadToEnd ( )
virtual

Reads characters from the stream until the end of the stream.

Returns
A string containing the read characters

Reimplemented in System::IO::StreamReader, and System::IO::StringReader.