Module reader [Version: v01]

[Documentation]

[Details]

[Wiki]

[Tests]

[Reader]

[AbsUniFileReader]

Compile status:
see log

Interfaces
Dependencies
Source Files
Licenses
Command-Line Interface (reader)
Exported Symbols
Internal Pointers
Build Log

Interfaces

Dependencies

For the Prokee Module Library

Dynamically Linked Modules:

module strconv (version 1 - 0 -- default: v01)

For the Standalone Executable

module strconv (version 1 - 0 -- default: v01)

Source Files

interface/prokee/reader/prokee.h
interface/prokee/reader/prokee_c.h
interface/prokee/mlocal.h
reader/reader.h
reader/ReaderImpl.h
reader/ReaderImpl.hpp
reader/FileReader.hpp
reader/StringReader.hpp
reader/StrReader.hpp
reader/WcsReader.hpp
interface/prokee/reader/prokee.cpp
interface/prokee/reader/prokee_c.cpp
reader/reader.cpp
reader/ReaderImpl.cpp
reader/FileReader.cpp
reader/StringReader.cpp
reader/StrReader.cpp
reader/WcsReader.cpp

Licenses

NO LICENSE

There is no license assigned to this module. Please contact the author to obtain a license.
Information about GPL licensing for this module.

This version of the module is not available with a GPL license. However, the main source code of this module is available as a part of other GPL software packages.

Command-Line Interface (reader)

    prokee::reader(1)
    Prokee Tools
    prokee::reader(1)

NAMEreader - Test command for module reader.

SYNOPSISreader FILE

DESCRIPTIONreader
reads the contents from file FILE and prints it to standard output.
All line breaks are converted into Unix-style line breaks.

This command is for testing purposes only. Mind, that it will not work properly when the character encoding of the file is not supported on your platform.

EXAMPLES
(1) Reads file input.txt and writes its contents to file output.txt.

    $ 
    reader input.txt > output.txt
    
(2) This results in deleting the contents of file test.txt.

    $ 
    reader test.txt > test.txt
    
AUTHORAndreas Pollhammer, info@andreaspollhammer.com

COPYRIGHTCopyrigt by Andreas Pollhammer

    v01
    2019
    prokee::reader(1)

Exported Symbols

Constructors

void *createStrReader(const char *a,int ln);
    

    void *createChar16Reader(const char16_t *a,int ln);
    

    void *createChar32Reader(const char32_t *a,int ln);
    

    void *createWcsReader(const wchar_t *a,int ln);
    

    void *createFileReader1(FILE *f);
    

    void *createFileReader2(const char *filename);
    

    void *createFileReader3(const wchar_t *filename);
    

    void *createWcsFileReader1(FILE *f);
    

    void *createWcsFileReader2(const char *filename);
    

    void *createWcsFileReader3(const wchar_t *filename);
    

    void *createChar16FileReader1(FILE *f);
    

    void *createChar16FileReader2(const char *filename);
    

    void *createChar16FileReader3(const wchar_t *filename);
    

    void *createChar32FileReader1(FILE *f);
    

    void *createChar32FileReader2(const char *filename);
    

    void *createChar32FileReader3(const wchar_t *filename);
    

    void *createUniFileReader1(FILE *f,int csize);
    

    void *createUniFileReader2(const char *filename,int csize);
    

    void *createUniFileReader3(const wchar_t *filename,int csize);

Destructors

void destroyStrReader(void *object);
    

    void destroyChar16Reader(void *object);
    

    void destroyChar32Reader(void *object);
    

    void destroyWcsReader(void *object);
    

    void destroyFileReader(void *object);
    

    void destroyWcsFileReader(void *object);
    

    void destroyChar16FileReader(void *object);
    

    void destroyChar32FileReader(void *object);
    

    void destroyUniFileReader(void *object);

Methods

int UniFileReader_getLine(void *object);
    

    int WcsReader_getLine(void *object);
    

    int FileReader_getLine(void *object);
    

    int WcsFileReader_getLine(void *object);
    

    int Char16FileReader_getLine(void *object);
    

    int Char32FileReader_getLine(void *object);
    

    int UniFileReader_getColumn(void *object);
    

    int WcsReader_getColumn(void *object);
    

    int FileReader_getColumn(void *object);
    

    int WcsFileReader_getColumn(void *object);
    

    int Char16FileReader_getColumn(void *object);
    

    int Char32FileReader_getColumn(void *object);
    

    int StrReader_get(void *object);
    

    int StrReader_getChar(void *object);
    

    int StrReader_getLastError(void *object);
    

    int StrReader_getLastErrorDetail(void *object);
    

    void StrReader_resetLastError(void *object);
    

    int StrReader_getCurrLine(void *object);
    

    int StrReader_getCurrColumn(void *object);
    

    void StrReader_setCurrLine(int n,void *object);
    

    void StrReader_setCurrColumn(int n,void *object);
    

    int Char16Reader_get(void *object);
    

    int Char16Reader_getChar(void *object);
    

    int Char16Reader_getLastError(void *object);
    

    int Char16Reader_getLastErrorDetail(void *object);
    

    void Char16Reader_resetLastError(void *object);
    

    int Char16Reader_getCurrLine(void *object);
    

    int Char16Reader_getCurrColumn(void *object);
    

    void Char16Reader_setCurrLine(int n,void *object);
    

    void Char16Reader_setCurrColumn(int n,void *object);
    

    int Char32Reader_get(void *object);
    

    int Char32Reader_getChar(void *object);
    

    int Char32Reader_getLastError(void *object);
    

    int Char32Reader_getLastErrorDetail(void *object);
    

    void Char32Reader_resetLastError(void *object);
    

    int Char32Reader_getCurrLine(void *object);
    

    int Char32Reader_getCurrColumn(void *object);
    

    void Char32Reader_setCurrLine(int n,void *object);
    

    void Char32Reader_setCurrColumn(int n,void *object);
    

    int WcsReader_get(void *object);
    

    int WcsReader_getChar(void *object);
    

    int WcsReader_getLastError(void *object);
    

    int WcsReader_getLastErrorDetail(void *object);
    

    void WcsReader_resetLastError(void *object);
    

    int WcsReader_getCurrLine(void *object);
    

    int WcsReader_getCurrColumn(void *object);
    

    void WcsReader_setCurrLine(int n,void *object);
    

    void WcsReader_setCurrColumn(int n,void *object);
    

    int FileReader_get(void *object);
    

    int FileReader_getChar(void *object);
    

    int FileReader_getLastError(void *object);
    

    int FileReader_getLastErrorDetail(void *object);
    

    void FileReader_resetLastError(void *object);
    

    int FileReader_getCurrLine(void *object);
    

    int FileReader_getCurrColumn(void *object);
    

    void FileReader_setCurrLine(int n,void *object);
    

    void FileReader_setCurrColumn(int n,void *object);
    

    int WcsFileReader_get(void *object);
    

    int WcsFileReader_getChar(void *object);
    

    int WcsFileReader_getLastError(void *object);
    

    int WcsFileReader_getLastErrorDetail(void *object);
    

    void WcsFileReader_resetLastError(void *object);
    

    int WcsFileReader_getCurrLine(void *object);
    

    int WcsFileReader_getCurrColumn(void *object);
    

    void WcsFileReader_setCurrLine(int n,void *object);
    

    void WcsFileReader_setCurrColumn(int n,void *object);
    

    int Char16FileReader_get(void *object);
    

    int Char16FileReader_getChar(void *object);
    

    int Char16FileReader_getLastError(void *object);
    

    int Char16FileReader_getLastErrorDetail(void *object);
    

    void Char16FileReader_resetLastError(void *object);
    

    int Char16FileReader_getCurrLine(void *object);
    

    int Char16FileReader_getCurrColumn(void *object);
    

    void Char16FileReader_setCurrLine(int n,void *object);
    

    void Char16FileReader_setCurrColumn(int n,void *object);
    

    int Char32FileReader_get(void *object);
    

    int Char32FileReader_getChar(void *object);
    

    int Char32FileReader_getLastError(void *object);
    

    int Char32FileReader_getLastErrorDetail(void *object);
    

    void Char32FileReader_resetLastError(void *object);
    

    int Char32FileReader_getCurrLine(void *object);
    

    int Char32FileReader_getCurrColumn(void *object);
    

    void Char32FileReader_setCurrLine(int n,void *object);
    

    void Char32FileReader_setCurrColumn(int n,void *object);
    

    int UniFileReader_get(void *object);
    

    int UniFileReader_getChar(void *object);
    

    int UniFileReader_getLastError(void *object);
    

    int UniFileReader_getLastErrorDetail(void *object);
    

    void UniFileReader_resetLastError(void *object);
    

    int UniFileReader_getCurrLine(void *object);
    

    int UniFileReader_getCurrColumn(void *object);
    

    void UniFileReader_setCurrLine(int n,void *object);
    

    void UniFileReader_setCurrColumn(int n,void *object);
    

    int UniFileReader_getCharSize(void *object);
    

    void UniFileReader_setCharSize(int csize,void *object);

Members

int Reader_get_currcolumn(void *object);
void Reader_set_currcolumn(void *object,int value);
int Reader_get_currline(void *object);
void Reader_set_currline(void *object,int value);
int Reader_get_line_break_char(void *object);
void Reader_set_line_break_char(void *object,int value);
int Reader_get_compatibility_mode(void *object);
void Reader_set_compatibility_mode(void *object,int value);

Internal Pointers

Constructors

The functions listed below are the "constructor functions" for creating objects of the linked module.
These functions can be used directly to omit the static wrapper methods.

void *reader_StrReader_createStrReader(const char *a,int ln);
    

    void *reader_Char16Reader_createChar16Reader(const char16_t *a,int ln);
    

    void *reader_Char32Reader_createChar32Reader(const char32_t *a,int ln);
    

    void *reader_WcsReader_createWcsReader(const wchar_t *a,int ln);
    

    void *reader_FileReader_createFileReader1(FILE *f);
    

    void *reader_FileReader_createFileReader2(const char *filename);
    

    void *reader_FileReader_createFileReader3(const wchar_t *filename);
    

    void *reader_WcsFileReader_createWcsFileReader1(FILE *f);
    

    void *reader_WcsFileReader_createWcsFileReader2(const char *filename);
    

    void *reader_WcsFileReader_createWcsFileReader3(const wchar_t *filename);
    

    void *reader_Char16FileReader_createChar16FileReader1(FILE *f);
    

    void *reader_Char16FileReader_createChar16FileReader2(const char *filename);
    

    void *reader_Char16FileReader_createChar16FileReader3(const wchar_t *filename);
    

    void *reader_Char32FileReader_createChar32FileReader1(FILE *f);
    

    void *reader_Char32FileReader_createChar32FileReader2(const char *filename);
    

    void *reader_Char32FileReader_createChar32FileReader3(const wchar_t *filename);
    

    void *reader_UniFileReader_createUniFileReader1(FILE *f,int csize);
    

    void *reader_UniFileReader_createUniFileReader2(const char *filename,int csize);
    

    void *reader_UniFileReader_createUniFileReader3(const wchar_t *filename,int csize);

The names of the functions are constructed according to the following pattern:

 <module>_<namespace>_<class>_create<class>(...)

where:
   <module> is the name of the module.
   <namespace> is the name of the namespace (optional).
   <class> is the name of the class.

Destructors

There are also destructor functions. These are equivalent to calling delete object;.
Do not call this functions directly.

void reader_StrReader_destroyStrReader(void *object);
    

    void reader_Char16Reader_destroyChar16Reader(void *object);
    

    void reader_Char32Reader_destroyChar32Reader(void *object);
    

    void reader_WcsReader_destroyWcsReader(void *object);
    

    void reader_FileReader_destroyFileReader(void *object);
    

    void reader_WcsFileReader_destroyWcsFileReader(void *object);
    

    void reader_Char16FileReader_destroyChar16FileReader(void *object);
    

    void reader_Char32FileReader_destroyChar32FileReader(void *object);
    

    void reader_UniFileReader_destroyUniFileReader(void *object);

The names of the functions are constructed according to the following pattern:

 <<module>_<namespace>_<class>_destroy<class>(void *object)

where:
   <module> is the name of the module.
   <namespace> is the name of the namespace (optional).
   <class> is the name of the class.
   object is the object to be destroyed.

Methods

These functions are used, if you created the object locally.
Do not call this functions directly.

int reader_UniFileReader_getLine(void *object);
    

    int reader_WcsReader_getLine(void *object);
    

    int reader_FileReader_getLine(void *object);
    

    int reader_WcsFileReader_getLine(void *object);
    

    int reader_Char16FileReader_getLine(void *object);
    

    int reader_Char32FileReader_getLine(void *object);
    

    int reader_UniFileReader_getColumn(void *object);
    

    int reader_WcsReader_getColumn(void *object);
    

    int reader_FileReader_getColumn(void *object);
    

    int reader_WcsFileReader_getColumn(void *object);
    

    int reader_Char16FileReader_getColumn(void *object);
    

    int reader_Char32FileReader_getColumn(void *object);
    

    int reader_StrReader_get(void *object);
    

    int reader_StrReader_getChar(void *object);
    

    int reader_StrReader_getLastError(void *object);
    

    int reader_StrReader_getLastErrorDetail(void *object);
    

    void reader_StrReader_resetLastError(void *object);
    

    int reader_StrReader_getCurrLine(void *object);
    

    int reader_StrReader_getCurrColumn(void *object);
    

    void reader_StrReader_setCurrLine(int n,void *object);
    

    void reader_StrReader_setCurrColumn(int n,void *object);
    

    int reader_Char16Reader_get(void *object);
    

    int reader_Char16Reader_getChar(void *object);
    

    int reader_Char16Reader_getLastError(void *object);
    

    int reader_Char16Reader_getLastErrorDetail(void *object);
    

    void reader_Char16Reader_resetLastError(void *object);
    

    int reader_Char16Reader_getCurrLine(void *object);
    

    int reader_Char16Reader_getCurrColumn(void *object);
    

    void reader_Char16Reader_setCurrLine(int n,void *object);
    

    void reader_Char16Reader_setCurrColumn(int n,void *object);
    

    int reader_Char32Reader_get(void *object);
    

    int reader_Char32Reader_getChar(void *object);
    

    int reader_Char32Reader_getLastError(void *object);
    

    int reader_Char32Reader_getLastErrorDetail(void *object);
    

    void reader_Char32Reader_resetLastError(void *object);
    

    int reader_Char32Reader_getCurrLine(void *object);
    

    int reader_Char32Reader_getCurrColumn(void *object);
    

    void reader_Char32Reader_setCurrLine(int n,void *object);
    

    void reader_Char32Reader_setCurrColumn(int n,void *object);
    

    int reader_WcsReader_get(void *object);
    

    int reader_WcsReader_getChar(void *object);
    

    int reader_WcsReader_getLastError(void *object);
    

    int reader_WcsReader_getLastErrorDetail(void *object);
    

    void reader_WcsReader_resetLastError(void *object);
    

    int reader_WcsReader_getCurrLine(void *object);
    

    int reader_WcsReader_getCurrColumn(void *object);
    

    void reader_WcsReader_setCurrLine(int n,void *object);
    

    void reader_WcsReader_setCurrColumn(int n,void *object);
    

    int reader_FileReader_get(void *object);
    

    int reader_FileReader_getChar(void *object);
    

    int reader_FileReader_getLastError(void *object);
    

    int reader_FileReader_getLastErrorDetail(void *object);
    

    void reader_FileReader_resetLastError(void *object);
    

    int reader_FileReader_getCurrLine(void *object);
    

    int reader_FileReader_getCurrColumn(void *object);
    

    void reader_FileReader_setCurrLine(int n,void *object);
    

    void reader_FileReader_setCurrColumn(int n,void *object);
    

    int reader_WcsFileReader_get(void *object);
    

    int reader_WcsFileReader_getChar(void *object);
    

    int reader_WcsFileReader_getLastError(void *object);
    

    int reader_WcsFileReader_getLastErrorDetail(void *object);
    

    void reader_WcsFileReader_resetLastError(void *object);
    

    int reader_WcsFileReader_getCurrLine(void *object);
    

    int reader_WcsFileReader_getCurrColumn(void *object);
    

    void reader_WcsFileReader_setCurrLine(int n,void *object);
    

    void reader_WcsFileReader_setCurrColumn(int n,void *object);
    

    int reader_Char16FileReader_get(void *object);
    

    int reader_Char16FileReader_getChar(void *object);
    

    int reader_Char16FileReader_getLastError(void *object);
    

    int reader_Char16FileReader_getLastErrorDetail(void *object);
    

    void reader_Char16FileReader_resetLastError(void *object);
    

    int reader_Char16FileReader_getCurrLine(void *object);
    

    int reader_Char16FileReader_getCurrColumn(void *object);
    

    void reader_Char16FileReader_setCurrLine(int n,void *object);
    

    void reader_Char16FileReader_setCurrColumn(int n,void *object);
    

    int reader_Char32FileReader_get(void *object);
    

    int reader_Char32FileReader_getChar(void *object);
    

    int reader_Char32FileReader_getLastError(void *object);
    

    int reader_Char32FileReader_getLastErrorDetail(void *object);
    

    void reader_Char32FileReader_resetLastError(void *object);
    

    int reader_Char32FileReader_getCurrLine(void *object);
    

    int reader_Char32FileReader_getCurrColumn(void *object);
    

    void reader_Char32FileReader_setCurrLine(int n,void *object);
    

    void reader_Char32FileReader_setCurrColumn(int n,void *object);
    

    int reader_UniFileReader_get(void *object);
    

    int reader_UniFileReader_getChar(void *object);
    

    int reader_UniFileReader_getLastError(void *object);
    

    int reader_UniFileReader_getLastErrorDetail(void *object);
    

    void reader_UniFileReader_resetLastError(void *object);
    

    int reader_UniFileReader_getCurrLine(void *object);
    

    int reader_UniFileReader_getCurrColumn(void *object);
    

    void reader_UniFileReader_setCurrLine(int n,void *object);
    

    void reader_UniFileReader_setCurrColumn(int n,void *object);
    

    int reader_UniFileReader_getCharSize(void *object);
    

    void reader_UniFileReader_setCharSize(int csize,void *object);

The names of the functions are constructed according to the following pattern:

 <module>_<namespace>_<class>_<method>(...,void *object)

where:
   <module> is the name of the module.
   <namespace> is the name of the namespace (optional).
   <class> is the name of the class.
   <method> is the name of the method.
   object is the object of which the method is called.

Members

These are the getter- and setter functions for public member variables.

int reader_Reader_get_currcolumn(void *object);
void reader_Reader_set_currcolumn(void *object,int value);
int reader_Reader_get_currline(void *object);
void reader_Reader_set_currline(void *object,int value);
int reader_Reader_get_line_break_char(void *object);
void reader_Reader_set_line_break_char(void *object,int value);
int reader_Reader_get_compatibility_mode(void *object);
void reader_Reader_set_compatibility_mode(void *object,int value);

The names of the functions are constructed according to the following pattern:

Getter-Function: <module>_<namespace>_<class>_get_<name>(void *object)
Setter-Function: <module>_<namespace>_<class>_set_<name>(void *object,...)

where:
   <module> is the name of the module.
   <namespace> is the name of the namespace (optional).
   <class> is the name of the class.
   <name> is the name of the variable.
   object is the object of which the method is called.

Build Log

--------------------------------------------------------------------------------
reader -- Mo Jän 27 15:51:04 CET 2020
--------------------------------------------------------------------------------
ERROR: Fehler beim öffnen der Datei files.def.
Fehlernummer: 2
-------------------------------------------------------------------------------
> install headers
-------------------------------------------------------------------------------
Executable for Linux/[local system] (CLI)

[compiling]
[end]

-------------------------------------------------------------------------------
Executable for Windows/[local system] (CLI)

[compiling]
[end]

-------------------------------------------------------------------------------
Dynamic library for Linux/[local system] (DLL)

[compiling]
[end]

-------------------------------------------------------------------------------
Dynamic library for Windows/[local system] (DLL)

[compiling]
[end]

-------------------------------------------------------------------------------
Static library for Linux/[local system] (LIB)

[compiling]
ar: creating ../../../../programs/bin/v01/lib_linux/libreader.a
[end]

-------------------------------------------------------------------------------
Static library for Windows/[local system] (LIB)

[compiling]
ar: creating ../../../../programs/bin/v01/lib_linux_win/libreader.a
[end]

-------------------------------------------------------------------------------
TESTS (Automated Tests for Linux/[local system])

[compiling]
[end]

-------------------------------------------------------------------------------
TESTS (Automated Tests for Windows/[local system])

[compiling]
[end]

-------------------------------------------------------------------------------
Executable for Linux/32bit (CLI)

[compiling]
[end]

-------------------------------------------------------------------------------
Executable for Windows/32bit (CLI)

[compiling]
[end]

-------------------------------------------------------------------------------
Dynamic library for Linux/32bit (DLL)

[compiling]
[end]

-------------------------------------------------------------------------------
Dynamic library for Windows/32bit (DLL)

[compiling]
[end]

-------------------------------------------------------------------------------
Static library for Linux/32bit (LIB)

[compiling]
ar: creating ../../../../programs/bin/v01/lib_linux32/libreader.a
[end]

-------------------------------------------------------------------------------
Static library for Windows/32bit (LIB)

[compiling]
ar: creating ../../../../programs/bin/v01/lib_linux_win32/libreader.a
[end]

-------------------------------------------------------------------------------
TESTS (Automated Tests for Linux/32bit)

[compiling]
[end]

-------------------------------------------------------------------------------
TESTS (Automated Tests for Windows/32bit)

[compiling]
[end]

-------------------------------------------------------------------------------
Executable for Linux/64bit (CLI)

[compiling]
[end]

-------------------------------------------------------------------------------
Executable for Windows/64bit (CLI)

[compiling]
[end]

-------------------------------------------------------------------------------
Dynamic library for Linux/64bit (DLL)

[compiling]
[end]

-------------------------------------------------------------------------------
Dynamic library for Windows/64bit (DLL)

[compiling]
[end]

-------------------------------------------------------------------------------
Static library for Linux/64bit (LIB)

[compiling]
ar: creating ../../../../programs/bin/v01/lib_linux64/libreader.a
[end]

-------------------------------------------------------------------------------
Static library for Windows/64bit (LIB)

[compiling]
ar: creating ../../../../programs/bin/v01/lib_linux_win64/libreader.a
[end]

-------------------------------------------------------------------------------
TESTS (Automated Tests for Linux/64bit)

[compiling]
[end]

-------------------------------------------------------------------------------
TESTS (Automated Tests for Windows/64bit)

[compiling]
[end]

-------------------------------------------------------------------------------
> test_all
-------------------------------------------------------------------------------
> prepare
-------------------------------------------------------------------------------
> install
creating /opt/prokee/system/reg/dllinfo/reader.v01.info ...
     license=1 | version=1 | library=libreader.v01
creating /opt/prokee/system/reg/dllinfo/reader.info ...
     license=1 | version=1 | library=libreader.v01
-------------------------------------------------------------------------------
> module
-------------------------------------------------------------------------------
> exepack
-------------------------------------------------------------------------------
> sourcepack
-------------------------------------------------------------------------------
> cleanup
-------------------------------------------------------------------------------
> webexport
--------------------------------------------------------------------------------
FERTIG
--------------------------------------------------------------------------------

Module reader [Version: v01]

Contents

Interfaces

Dependencies

Source Files

Licenses

Command-Line Interface (reader)

Exported Symbols

Constructors

Destructors

Methods

Members

Internal Pointers

Constructors

Destructors

Methods

Members

Build Log