HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HDK_Sample::FS_HomeReadHelper Class Reference

Class to open a file as a read stream. The class tests for a "home:" prefix and replaces it with $HOME. More...

#include <FS_HomeHelper.h>

+ Inheritance diagram for HDK_Sample::FS_HomeReadHelper:

Public Member Functions

 FS_HomeReadHelper ()
 
 ~FS_HomeReadHelper () override
 
FS_ReaderStreamcreateStream (const char *source, const UT_Options *options) override
 If the filename starts with "home:", open an FS_ReaderStream. More...
 
bool splitIndexFileSectionPath (const char *source_section_path, UT_String &index_file_path, UT_String &section_name) override
 
bool combineIndexFileSectionPath (UT_String &source_section_path, const char *index_file_path, const char *section_name) override
 
- Public Member Functions inherited from FS_ReaderHelper
 FS_ReaderHelper ()
 
virtual ~FS_ReaderHelper ()
 

Detailed Description

Class to open a file as a read stream. The class tests for a "home:" prefix and replaces it with $HOME.

Examples:
FS/FS_HomeHelper.C.

Definition at line 54 of file FS_HomeHelper.h.

Constructor & Destructor Documentation

FS_HomeReadHelper::FS_HomeReadHelper ( )
Examples:
FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 357 of file FS_HomeHelper.C.

FS_HomeReadHelper::~FS_HomeReadHelper ( )
override
Examples:
FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 362 of file FS_HomeHelper.C.

Member Function Documentation

bool FS_HomeReadHelper::combineIndexFileSectionPath ( UT_String source_section_path,
const char *  index_file_path,
const char *  section_name 
)
overridevirtual

Utility function to combine index file name and section name into the section path. Performs the reverse of splitIndexFileSectionPath(). Please, see the base class for more documentation.

Reimplemented from FS_ReaderHelper.

Examples:
FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 418 of file FS_HomeHelper.C.

FS_ReaderStream * FS_HomeReadHelper::createStream ( const char *  source,
const UT_Options options 
)
overridevirtual

If the filename starts with "home:", open an FS_ReaderStream.

Implements FS_ReaderHelper.

Examples:
FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 367 of file FS_HomeHelper.C.

bool FS_HomeReadHelper::splitIndexFileSectionPath ( const char *  source_section_path,
UT_String index_file_path,
UT_String section_name 
)
overridevirtual

Parse the source path into the index file path and the section name. Please, see the base class for more documentation.

Reimplemented from FS_ReaderHelper.

Examples:
FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 379 of file FS_HomeHelper.C.


The documentation for this class was generated from the following files: