\hypertarget{class_qore_1_1_file_line_iterator}{}\section{Qore\+:\+:File\+Line\+Iterator Class Reference}
\label{class_qore_1_1_file_line_iterator}\index{Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}}


This class defines a line iterator for text files.  




Inheritance diagram for Qore\+:\+:File\+Line\+Iterator\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=212pt]{class_qore_1_1_file_line_iterator__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{class_qore_1_1_file_line_iterator_a61680f06d6976f40619736a59a04e754}{constructor}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} path, \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} encoding, \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} eol, bool \mbox{\hyperlink{group__string__functions_gae8d314e819a299d46d181696600d4293}{trim}}=\mbox{\hyperlink{group__boolean__constants_ga3ba2df91713a6249449347131ea526c3}{True}})
\begin{DoxyCompactList}\small\item\em Opens the given file for reading with the given options and creates the \mbox{\hyperlink{class_qore_1_1_file_line_iterator}{File\+Line\+Iterator}} object. \end{DoxyCompactList}\item 
\mbox{\hyperlink{class_qore_1_1_file_line_iterator_a00df8c3068548371230467c0cbca0169}{copy}} ()
\begin{DoxyCompactList}\small\item\em Creates a new \mbox{\hyperlink{class_qore_1_1_file_line_iterator}{File\+Line\+Iterator}} object, based on the same object being iterated in the original object (the original file is reopened) \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{class_qore_1_1_file_line_iterator_ada463647abb761af55b6b6964c80c299}{get\+Encoding}} ()
\begin{DoxyCompactList}\small\item\em Returns the \mbox{\hyperlink{character_encoding}{character encoding}} for the File\+Line\+Iterator. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{class_qore_1_1_file_line_iterator_a06a105043332a4c4ff52a3c2d3bcc163}{get\+File\+Name}} ()
\begin{DoxyCompactList}\small\item\em Returns the file path/name used to open the file. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{class_qore_1_1_file_line_iterator_a0d738d5e8d770c1e50baf275e9ca3981}{get\+Line}} ()
\begin{DoxyCompactList}\small\item\em Returns the current line in the file or throws an {\ttfamily I\+T\+E\+R\+A\+T\+O\+R-\/\+E\+R\+R\+OR} exception if the iterator is invalid. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{class_qore_1_1_file_line_iterator_a83dc18c41ade9e9503d3d21785accbd3}{get\+Value}} ()
\begin{DoxyCompactList}\small\item\em Returns the current line in the file or throws an {\ttfamily I\+T\+E\+R\+A\+T\+O\+R-\/\+E\+R\+R\+OR} exception if the iterator is invalid. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__type__conversion__functions_ga5182bb860e3837e1eb337e85a9b3ebd6}{hash}}$<$ \mbox{\hyperlink{struct_qore_1_1_stat_info}{Stat\+Info}} $>$ \mbox{\hyperlink{class_qore_1_1_file_line_iterator_afd0b7665ba69bba57fa903410680773f}{hstat}} ()
\begin{DoxyCompactList}\small\item\em Returns \mbox{\hyperlink{struct_qore_1_1_stat_info}{Stat\+Info}} hash of \mbox{\hyperlink{class_qore_1_1_file_line_iterator_afd0b7665ba69bba57fa903410680773f}{hstat()}} of the underlying file. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{class_qore_1_1_file_line_iterator_a9eb374145fd48a41420b96684ff895f5}{index}} ()
\begin{DoxyCompactList}\small\item\em Returns the current iterator line number in the file (the first line is line 1) or 0 if not pointing at a valid element. \end{DoxyCompactList}\item 
bool \mbox{\hyperlink{class_qore_1_1_file_line_iterator_a33ae9488dfc60606876eb1f4c9b2be9a}{is\+Tty}} ()
\begin{DoxyCompactList}\small\item\em Returns \mbox{\hyperlink{group__boolean__constants_ga3ba2df91713a6249449347131ea526c3}{True}} if the \mbox{\hyperlink{class_qore_1_1_file_line_iterator}{File\+Line\+Iterator}} is connected to a terminal device, \mbox{\hyperlink{group__boolean__constants_ga9da2b9a8003cd3788e48305f8a00540f}{False}} if not. \end{DoxyCompactList}\item 
bool \mbox{\hyperlink{class_qore_1_1_file_line_iterator_a9e6ad34f365bfeb5e4bcd045daf43921}{next}} ()
\begin{DoxyCompactList}\small\item\em Moves the current position to the next line in the file; returns \mbox{\hyperlink{group__boolean__constants_ga9da2b9a8003cd3788e48305f8a00540f}{False}} if there are no more lines to read; if the iterator is not pointing at a valid element before this call, the iterator will be positioned to the beginning of the file. \end{DoxyCompactList}\item 
\mbox{\hyperlink{class_qore_1_1_file_line_iterator_aa202848cc75284b73f315a07fdd0e0b2}{reset}} ()
\begin{DoxyCompactList}\small\item\em Reset the iterator instance to its initial state. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__type__conversion__functions_ga8f596b49953b71928f04c24b19834bc3}{list}} \mbox{\hyperlink{class_qore_1_1_file_line_iterator_a07e6595ecf2b7cc2789cbd0778276b0e}{stat}} ()
\begin{DoxyCompactList}\small\item\em Returns \mbox{\hyperlink{group__filesystem__functions_stat_list}{Stat List}} of \mbox{\hyperlink{class_qore_1_1_file_line_iterator_a07e6595ecf2b7cc2789cbd0778276b0e}{stat()}} of the underlying file. \end{DoxyCompactList}\item 
bool \mbox{\hyperlink{class_qore_1_1_file_line_iterator_a93c4a650206085736f7bf8efe89ff613}{valid}} ()
\begin{DoxyCompactList}\small\item\em Returns \mbox{\hyperlink{group__boolean__constants_ga3ba2df91713a6249449347131ea526c3}{True}} if the iterator is currently pointing at a valid element, \mbox{\hyperlink{group__boolean__constants_ga9da2b9a8003cd3788e48305f8a00540f}{False}} if not. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
This class defines a line iterator for text files. 

\begin{DoxySince}{Since}
Qore 0.\+8.\+6
\end{DoxySince}
\begin{DoxyParagraph}{Restrictions\+:}
\mbox{\hyperlink{group__parse__options_ga5e466ed886222f0b57b0a399b455be71}{Qore\+::\+P\+O\+\_\+\+N\+O\+\_\+\+F\+I\+L\+E\+S\+Y\+S\+T\+EM}}
\end{DoxyParagraph}
\begin{DoxyParagraph}{Example\+: File\+Line\+Iterator basic usage}

\begin{DoxyCode}
file content:
a2ps-4.13-1332.1.x86\_64
a2ps-devel-4.13-1332.1.x86\_64
aaa\_base-11.3-7.2.x86\_64
...

FileLineIterator it(\textcolor{stringliteral}{"/export/home/pvanek/ren.list"});
\textcolor{keywordflow}{while} (it.next()) \{
    \mbox{\hyperlink{group__string__functions_ga32070517a9f8a70a32ef48f83a6f128e}{printf}}(\textcolor{stringliteral}{"%s:%d = %n\(\backslash\)n"}, it.getFileName(), it.index(), it.getValue());
\}

/export/home/pvanek/ren.list:1 = \textcolor{stringliteral}{"a2ps-4.13-1332.1.x86\_64"}
/export/home/pvanek/ren.list:2 = \textcolor{stringliteral}{"a2ps-devel-4.13-1332.1.x86\_64"}
/export/home/pvanek/ren.list:3 = \textcolor{stringliteral}{"aaa\_base-11.3-7.2.x86\_64"}
...
/export/home/pvanek/ren.list:2155 = \textcolor{stringliteral}{"zypper-1.4.5-1.10.x86\_64"}
\end{DoxyCode}

\end{DoxyParagraph}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{class_qore_1_1_input_stream_line_iterator}{Qore\+::\+Input\+Stream\+Line\+Iterator}} 

\mbox{\hyperlink{class_qore_1_1_data_line_iterator}{Qore\+::\+Data\+Line\+Iterator}} 
\end{DoxySeeAlso}


\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_qore_1_1_file_line_iterator_a61680f06d6976f40619736a59a04e754}\label{class_qore_1_1_file_line_iterator_a61680f06d6976f40619736a59a04e754}} 
\index{Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}!constructor@{constructor}}
\index{constructor@{constructor}!Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}}
\subsubsection{\texorpdfstring{constructor()}{constructor()}}
{\footnotesize\ttfamily Qore\+::\+File\+Line\+Iterator\+::constructor (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{path,  }\item[{\+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{encoding,  }\item[{\+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{eol,  }\item[{bool}]{trim = {\ttfamily \mbox{\hyperlink{group__boolean__constants_ga3ba2df91713a6249449347131ea526c3}{True}}} }\end{DoxyParamCaption})}



Opens the given file for reading with the given options and creates the \mbox{\hyperlink{class_qore_1_1_file_line_iterator}{File\+Line\+Iterator}} object. 


\begin{DoxyParams}{Parameters}
{\em path} & the path to open for reading \\
\hline
{\em encoding} & character encoding of the data in the file; if not A\+S\+C\+I\+I-\/compatible, all data will be converted to U\+T\+F-\/8; if not present, the \mbox{\hyperlink{character_encoding_default_encoding}{default character encoding}} is assumed \\
\hline
{\em eol} & the optional end of line character(s) to use to detect lines in the file; if this string is not passed, then the end of line character(s) are detected automatically, and can be either {\ttfamily \char`\"{}\textbackslash{}n\char`\"{}}, {\ttfamily \char`\"{}\textbackslash{}r\char`\"{}}, or {\ttfamily \char`\"{}\textbackslash{}r\textbackslash{}n\char`\"{}} (the last one is only automatically detected when not connected to a terminal device in order to keep the I/O from stalling); if this string is passed and has a different \mbox{\hyperlink{character_encoding}{character encoding}} from this object\textquotesingle{}s (as determined by the {\ttfamily encoding} parameter), then it will be converted to the \mbox{\hyperlink{class_qore_1_1_file_line_iterator}{File\+Line\+Iterator}}\textquotesingle{}s \mbox{\hyperlink{character_encoding}{character encoding}} \\
\hline
{\em trim} & if \mbox{\hyperlink{group__boolean__constants_ga3ba2df91713a6249449347131ea526c3}{True}} the string return values for the lines iterated will be trimmed of the eol bytes\\
\hline
\end{DoxyParams}

\begin{DoxyExceptions}{Exceptions}
{\em E\+N\+C\+O\+D\+I\+N\+G-\/\+C\+O\+N\+V\+E\+R\+S\+I\+O\+N-\/\+E\+R\+R\+OR} & this exception could be thrown if the eol argument has a different \mbox{\hyperlink{character_encoding}{character encoding}} from the \mbox{\hyperlink{class_qore_1_1_file}{File}}\textquotesingle{}s and an error occurs during encoding conversion \\
\hline
{\em I\+L\+L\+E\+G\+A\+L-\/\+E\+X\+P\+R\+E\+S\+S\+I\+ON} & \mbox{\hyperlink{class_qore_1_1_file_line_iterator_a61680f06d6976f40619736a59a04e754}{File\+Line\+Iterator\+::constructor()}} cannot be called with a T\+TY target when \mbox{\hyperlink{parse_directives_no-terminal-io}{\%no-\/terminal-\/io}} is set \\
\hline
\end{DoxyExceptions}
\mbox{\Hypertarget{class_qore_1_1_file_line_iterator_a00df8c3068548371230467c0cbca0169}\label{class_qore_1_1_file_line_iterator_a00df8c3068548371230467c0cbca0169}} 
\index{Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}!copy@{copy}}
\index{copy@{copy}!Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}}
\subsubsection{\texorpdfstring{copy()}{copy()}}
{\footnotesize\ttfamily Qore\+::\+File\+Line\+Iterator\+::copy (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Creates a new \mbox{\hyperlink{class_qore_1_1_file_line_iterator}{File\+Line\+Iterator}} object, based on the same object being iterated in the original object (the original file is reopened) 

\begin{DoxyParagraph}{Example\+:}

\begin{DoxyCode}
FileLineIterator ni = i.copy();
\end{DoxyCode}

\end{DoxyParagraph}

\begin{DoxyExceptions}{Exceptions}
{\em I\+L\+L\+E\+G\+A\+L-\/\+E\+X\+P\+R\+E\+S\+S\+I\+ON} & \mbox{\hyperlink{class_qore_1_1_file_line_iterator_a61680f06d6976f40619736a59a04e754}{File\+Line\+Iterator\+::constructor()}} cannot be called with a T\+TY target when \mbox{\hyperlink{parse_directives_no-terminal-io}{\%no-\/terminal-\/io}} is set \\
\hline
\end{DoxyExceptions}
\mbox{\Hypertarget{class_qore_1_1_file_line_iterator_ada463647abb761af55b6b6964c80c299}\label{class_qore_1_1_file_line_iterator_ada463647abb761af55b6b6964c80c299}} 
\index{Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}!get\+Encoding@{get\+Encoding}}
\index{get\+Encoding@{get\+Encoding}!Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}}
\subsubsection{\texorpdfstring{get\+Encoding()}{getEncoding()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::\+File\+Line\+Iterator\+::get\+Encoding (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Returns the \mbox{\hyperlink{character_encoding}{character encoding}} for the File\+Line\+Iterator. 

\begin{DoxyParagraph}{Code Flags\+:}
\mbox{\hyperlink{code_flags_CONSTANT}{C\+O\+N\+S\+T\+A\+NT}}
\end{DoxyParagraph}
\begin{DoxyParagraph}{Example\+:}

\begin{DoxyCode}
string encoding = f.getEncoding();
\end{DoxyCode}

\end{DoxyParagraph}
\begin{DoxyReturn}{Returns}
the \mbox{\hyperlink{character_encoding}{character encoding}} for the File\+Line\+Iterator 
\end{DoxyReturn}
\mbox{\Hypertarget{class_qore_1_1_file_line_iterator_a06a105043332a4c4ff52a3c2d3bcc163}\label{class_qore_1_1_file_line_iterator_a06a105043332a4c4ff52a3c2d3bcc163}} 
\index{Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}!get\+File\+Name@{get\+File\+Name}}
\index{get\+File\+Name@{get\+File\+Name}!Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}}
\subsubsection{\texorpdfstring{get\+File\+Name()}{getFileName()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::\+File\+Line\+Iterator\+::get\+File\+Name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Returns the file path/name used to open the file. 

\begin{DoxyParagraph}{Code Flags\+:}
\mbox{\hyperlink{code_flags_CONSTANT}{C\+O\+N\+S\+T\+A\+NT}}
\end{DoxyParagraph}
\begin{DoxyParagraph}{Example\+:}

\begin{DoxyCode}
string fn = f.getFileName();
\end{DoxyCode}

\end{DoxyParagraph}
\begin{DoxyReturn}{Returns}
the file path/name used to open the file 
\end{DoxyReturn}
\mbox{\Hypertarget{class_qore_1_1_file_line_iterator_a0d738d5e8d770c1e50baf275e9ca3981}\label{class_qore_1_1_file_line_iterator_a0d738d5e8d770c1e50baf275e9ca3981}} 
\index{Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}!get\+Line@{get\+Line}}
\index{get\+Line@{get\+Line}!Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}}
\subsubsection{\texorpdfstring{get\+Line()}{getLine()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::\+File\+Line\+Iterator\+::get\+Line (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Returns the current line in the file or throws an {\ttfamily I\+T\+E\+R\+A\+T\+O\+R-\/\+E\+R\+R\+OR} exception if the iterator is invalid. 

\begin{DoxyReturn}{Returns}
the current line in the file or throws an {\ttfamily I\+T\+E\+R\+A\+T\+O\+R-\/\+E\+R\+R\+OR} exception if the iterator is invalid
\end{DoxyReturn}
\begin{DoxyParagraph}{Code Flags\+:}
\mbox{\hyperlink{code_flags_RET_VALUE_ONLY}{R\+E\+T\+\_\+\+V\+A\+L\+U\+E\+\_\+\+O\+N\+LY}}
\end{DoxyParagraph}
\begin{DoxyParagraph}{Example\+:}

\begin{DoxyCode}
\textcolor{keywordflow}{while} (i.next()) \{
    \mbox{\hyperlink{group__string__functions_ga32070517a9f8a70a32ef48f83a6f128e}{printf}}(\textcolor{stringliteral}{"+ %y\(\backslash\)n"}, i.getLine());
\}
\end{DoxyCode}

\end{DoxyParagraph}

\begin{DoxyExceptions}{Exceptions}
{\em I\+T\+E\+R\+A\+T\+O\+R-\/\+E\+R\+R\+OR} & the iterator is not pointing at a valid element \\
\hline
{\em I\+T\+E\+R\+A\+T\+O\+R-\/\+T\+H\+R\+E\+A\+D-\/\+E\+R\+R\+OR} & this exception is thrown if this method is called from any thread other than the thread that created the object\\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{class_qore_1_1_file_line_iterator_a83dc18c41ade9e9503d3d21785accbd3}{File\+Line\+Iterator\+::get\+Value()}} 
\end{DoxySeeAlso}


Implements \mbox{\hyperlink{class_qore_1_1_abstract_line_iterator_a8ad4c0503f09b24e93bbeac266f2b2a0}{Qore\+::\+Abstract\+Line\+Iterator}}.

\mbox{\Hypertarget{class_qore_1_1_file_line_iterator_a83dc18c41ade9e9503d3d21785accbd3}\label{class_qore_1_1_file_line_iterator_a83dc18c41ade9e9503d3d21785accbd3}} 
\index{Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}!get\+Value@{get\+Value}}
\index{get\+Value@{get\+Value}!Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}}
\subsubsection{\texorpdfstring{get\+Value()}{getValue()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::\+File\+Line\+Iterator\+::get\+Value (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Returns the current line in the file or throws an {\ttfamily I\+T\+E\+R\+A\+T\+O\+R-\/\+E\+R\+R\+OR} exception if the iterator is invalid. 

\begin{DoxyReturn}{Returns}
the current line in the file or throws an {\ttfamily I\+T\+E\+R\+A\+T\+O\+R-\/\+E\+R\+R\+OR} exception if the iterator is invalid
\end{DoxyReturn}
\begin{DoxyParagraph}{Code Flags\+:}
\mbox{\hyperlink{code_flags_RET_VALUE_ONLY}{R\+E\+T\+\_\+\+V\+A\+L\+U\+E\+\_\+\+O\+N\+LY}}
\end{DoxyParagraph}
\begin{DoxyParagraph}{Example\+:}

\begin{DoxyCode}
\textcolor{keywordflow}{while} (i.next()) \{
    \mbox{\hyperlink{group__string__functions_ga32070517a9f8a70a32ef48f83a6f128e}{printf}}(\textcolor{stringliteral}{"+ %y\(\backslash\)n"}, i.getValue());
\}
\end{DoxyCode}

\end{DoxyParagraph}

\begin{DoxyExceptions}{Exceptions}
{\em I\+T\+E\+R\+A\+T\+O\+R-\/\+E\+R\+R\+OR} & the iterator is not pointing at a valid element \\
\hline
{\em I\+T\+E\+R\+A\+T\+O\+R-\/\+T\+H\+R\+E\+A\+D-\/\+E\+R\+R\+OR} & this exception is thrown if this method is called from any thread other than the thread that created the object\\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{class_qore_1_1_file_line_iterator_a0d738d5e8d770c1e50baf275e9ca3981}{File\+Line\+Iterator\+::get\+Line()}} 
\end{DoxySeeAlso}


Implements \mbox{\hyperlink{class_qore_1_1_abstract_line_iterator_acc1342afce2820c3d1dded7aeb2b8dd8}{Qore\+::\+Abstract\+Line\+Iterator}}.

\mbox{\Hypertarget{class_qore_1_1_file_line_iterator_afd0b7665ba69bba57fa903410680773f}\label{class_qore_1_1_file_line_iterator_afd0b7665ba69bba57fa903410680773f}} 
\index{Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}!hstat@{hstat}}
\index{hstat@{hstat}!Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}}
\subsubsection{\texorpdfstring{hstat()}{hstat()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga5182bb860e3837e1eb337e85a9b3ebd6}{hash}}$<$\mbox{\hyperlink{struct_qore_1_1_stat_info}{Stat\+Info}}$>$ Qore\+::\+File\+Line\+Iterator\+::hstat (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Returns \mbox{\hyperlink{struct_qore_1_1_stat_info}{Stat\+Info}} hash of \mbox{\hyperlink{class_qore_1_1_file_line_iterator_afd0b7665ba69bba57fa903410680773f}{hstat()}} of the underlying file. 

If any errors occur, a {\ttfamily F\+I\+L\+E-\/\+H\+S\+T\+A\+T-\/\+E\+R\+R\+OR} exception is thrown

\begin{DoxyParagraph}{Code Flags\+:}
\mbox{\hyperlink{code_flags_CONSTANT}{C\+O\+N\+S\+T\+A\+NT}}
\end{DoxyParagraph}
\begin{DoxyParagraph}{Example\+:}

\begin{DoxyCode}
hash h = f.hstat();
\end{DoxyCode}

\end{DoxyParagraph}
\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{struct_qore_1_1_stat_info}{Stat\+Info}} hash of \mbox{\hyperlink{class_qore_1_1_file_line_iterator_afd0b7665ba69bba57fa903410680773f}{hstat()}} of the underlying file
\end{DoxyReturn}
\begin{DoxySince}{Since}
Qore 0.\+8.\+12 
\end{DoxySince}
\mbox{\Hypertarget{class_qore_1_1_file_line_iterator_a9eb374145fd48a41420b96684ff895f5}\label{class_qore_1_1_file_line_iterator_a9eb374145fd48a41420b96684ff895f5}} 
\index{Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}!index@{index}}
\index{index@{index}!Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}}
\subsubsection{\texorpdfstring{index()}{index()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::\+File\+Line\+Iterator\+::index (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Returns the current iterator line number in the file (the first line is line 1) or 0 if not pointing at a valid element. 

\begin{DoxyReturn}{Returns}
the current iterator line number in the file (the first line is line 1) or 0 if not pointing at a valid element
\end{DoxyReturn}
\begin{DoxyParagraph}{Code Flags\+:}
\mbox{\hyperlink{code_flags_CONSTANT}{C\+O\+N\+S\+T\+A\+NT}}
\end{DoxyParagraph}
\begin{DoxyParagraph}{Example\+:}

\begin{DoxyCode}
\textcolor{keywordflow}{while} (i.next()) \{
    \mbox{\hyperlink{group__string__functions_ga32070517a9f8a70a32ef48f83a6f128e}{printf}}(\textcolor{stringliteral}{"+ %d: %y\(\backslash\)n"}, i.index(), i.getValue());
\}
\end{DoxyCode}
 
\end{DoxyParagraph}


Implements \mbox{\hyperlink{class_qore_1_1_abstract_line_iterator_acde61f19ac0b96adcaafbe4962e9a335}{Qore\+::\+Abstract\+Line\+Iterator}}.

\mbox{\Hypertarget{class_qore_1_1_file_line_iterator_a33ae9488dfc60606876eb1f4c9b2be9a}\label{class_qore_1_1_file_line_iterator_a33ae9488dfc60606876eb1f4c9b2be9a}} 
\index{Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}!is\+Tty@{is\+Tty}}
\index{is\+Tty@{is\+Tty}!Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}}
\subsubsection{\texorpdfstring{is\+Tty()}{isTty()}}
{\footnotesize\ttfamily bool Qore\+::\+File\+Line\+Iterator\+::is\+Tty (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Returns \mbox{\hyperlink{group__boolean__constants_ga3ba2df91713a6249449347131ea526c3}{True}} if the \mbox{\hyperlink{class_qore_1_1_file_line_iterator}{File\+Line\+Iterator}} is connected to a terminal device, \mbox{\hyperlink{group__boolean__constants_ga9da2b9a8003cd3788e48305f8a00540f}{False}} if not. 

\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{group__boolean__constants_ga3ba2df91713a6249449347131ea526c3}{True}} if the \mbox{\hyperlink{class_qore_1_1_file_line_iterator}{File\+Line\+Iterator}} is connected to a terminal device, \mbox{\hyperlink{group__boolean__constants_ga9da2b9a8003cd3788e48305f8a00540f}{False}} if not
\end{DoxyReturn}
\begin{DoxyParagraph}{Code Flags\+:}
\mbox{\hyperlink{code_flags_CONSTANT}{C\+O\+N\+S\+T\+A\+NT}}
\end{DoxyParagraph}
\begin{DoxyParagraph}{Example\+:}

\begin{DoxyCode}
bool b = i.isTty();
\end{DoxyCode}
 
\end{DoxyParagraph}
\mbox{\Hypertarget{class_qore_1_1_file_line_iterator_a9e6ad34f365bfeb5e4bcd045daf43921}\label{class_qore_1_1_file_line_iterator_a9e6ad34f365bfeb5e4bcd045daf43921}} 
\index{Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}!next@{next}}
\index{next@{next}!Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}}
\subsubsection{\texorpdfstring{next()}{next()}}
{\footnotesize\ttfamily bool Qore\+::\+File\+Line\+Iterator\+::next (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Moves the current position to the next line in the file; returns \mbox{\hyperlink{group__boolean__constants_ga9da2b9a8003cd3788e48305f8a00540f}{False}} if there are no more lines to read; if the iterator is not pointing at a valid element before this call, the iterator will be positioned to the beginning of the file. 

This method will return \mbox{\hyperlink{group__boolean__constants_ga3ba2df91713a6249449347131ea526c3}{True}} again after it returns \mbox{\hyperlink{group__boolean__constants_ga9da2b9a8003cd3788e48305f8a00540f}{False}} once if file is not empty, otherwise it will always return \mbox{\hyperlink{group__boolean__constants_ga9da2b9a8003cd3788e48305f8a00540f}{False}} The iterator object should not be used after this method returns \mbox{\hyperlink{group__boolean__constants_ga9da2b9a8003cd3788e48305f8a00540f}{False}}

\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{group__boolean__constants_ga9da2b9a8003cd3788e48305f8a00540f}{False}} if there are no more lines in the file (in which case the iterator object is invalid and should not be used); \mbox{\hyperlink{group__boolean__constants_ga3ba2df91713a6249449347131ea526c3}{True}} if successful (meaning that the iterator object is valid)
\end{DoxyReturn}
\begin{DoxyParagraph}{Example\+:}

\begin{DoxyCode}
\textcolor{keywordflow}{while} (i.next()) \{
    \mbox{\hyperlink{group__string__functions_ga32070517a9f8a70a32ef48f83a6f128e}{printf}}(\textcolor{stringliteral}{"line: %y\(\backslash\)n"}, i.getValue());
\}
\end{DoxyCode}

\end{DoxyParagraph}

\begin{DoxyExceptions}{Exceptions}
{\em I\+T\+E\+R\+A\+T\+O\+R-\/\+T\+H\+R\+E\+A\+D-\/\+E\+R\+R\+OR} & this exception is thrown if this method is called from any thread other than the thread that created the object \\
\hline
\end{DoxyExceptions}


Implements \mbox{\hyperlink{class_qore_1_1_abstract_line_iterator_ac5f7742a325b335f3cd2ab0bb5f37272}{Qore\+::\+Abstract\+Line\+Iterator}}.

\mbox{\Hypertarget{class_qore_1_1_file_line_iterator_aa202848cc75284b73f315a07fdd0e0b2}\label{class_qore_1_1_file_line_iterator_aa202848cc75284b73f315a07fdd0e0b2}} 
\index{Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}!reset@{reset}}
\index{reset@{reset}!Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}}
\subsubsection{\texorpdfstring{reset()}{reset()}}
{\footnotesize\ttfamily Qore\+::\+File\+Line\+Iterator\+::reset (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Reset the iterator instance to its initial state. 

Reset the iterator instance to its initial state

\begin{DoxyParagraph}{Example}

\begin{DoxyCode}
i.reset();
\end{DoxyCode}

\end{DoxyParagraph}

\begin{DoxyExceptions}{Exceptions}
{\em I\+T\+E\+R\+A\+T\+O\+R-\/\+T\+H\+R\+E\+A\+D-\/\+E\+R\+R\+OR} & this exception is thrown if this method is called from any thread other than the thread that created the object \\
\hline
\end{DoxyExceptions}
\mbox{\Hypertarget{class_qore_1_1_file_line_iterator_a07e6595ecf2b7cc2789cbd0778276b0e}\label{class_qore_1_1_file_line_iterator_a07e6595ecf2b7cc2789cbd0778276b0e}} 
\index{Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}!stat@{stat}}
\index{stat@{stat}!Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}}
\subsubsection{\texorpdfstring{stat()}{stat()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga8f596b49953b71928f04c24b19834bc3}{list}} Qore\+::\+File\+Line\+Iterator\+::stat (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Returns \mbox{\hyperlink{group__filesystem__functions_stat_list}{Stat List}} of \mbox{\hyperlink{class_qore_1_1_file_line_iterator_a07e6595ecf2b7cc2789cbd0778276b0e}{stat()}} of the underlying file. 

If any errors occur, a {\ttfamily F\+I\+L\+E-\/\+H\+S\+T\+A\+T-\/\+E\+R\+R\+OR} exception is thrown

\begin{DoxyParagraph}{Code Flags\+:}
\mbox{\hyperlink{code_flags_CONSTANT}{C\+O\+N\+S\+T\+A\+NT}}
\end{DoxyParagraph}
\begin{DoxyParagraph}{Example\+:}

\begin{DoxyCode}
list l = f.stat();
\end{DoxyCode}

\end{DoxyParagraph}
\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{group__filesystem__functions_stat_list}{Stat List}} of \mbox{\hyperlink{class_qore_1_1_file_line_iterator_a07e6595ecf2b7cc2789cbd0778276b0e}{stat()}} of the underlying file 
\end{DoxyReturn}
\begin{DoxySince}{Since}
Qore 0.\+8.\+12 
\end{DoxySince}
\mbox{\Hypertarget{class_qore_1_1_file_line_iterator_a93c4a650206085736f7bf8efe89ff613}\label{class_qore_1_1_file_line_iterator_a93c4a650206085736f7bf8efe89ff613}} 
\index{Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}!valid@{valid}}
\index{valid@{valid}!Qore\+::\+File\+Line\+Iterator@{Qore\+::\+File\+Line\+Iterator}}
\subsubsection{\texorpdfstring{valid()}{valid()}}
{\footnotesize\ttfamily bool Qore\+::\+File\+Line\+Iterator\+::valid (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Returns \mbox{\hyperlink{group__boolean__constants_ga3ba2df91713a6249449347131ea526c3}{True}} if the iterator is currently pointing at a valid element, \mbox{\hyperlink{group__boolean__constants_ga9da2b9a8003cd3788e48305f8a00540f}{False}} if not. 

\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{group__boolean__constants_ga3ba2df91713a6249449347131ea526c3}{True}} if the iterator is currently pointing at a valid element, \mbox{\hyperlink{group__boolean__constants_ga9da2b9a8003cd3788e48305f8a00540f}{False}} if not
\end{DoxyReturn}
\begin{DoxyParagraph}{Code Flags\+:}
\mbox{\hyperlink{code_flags_CONSTANT}{C\+O\+N\+S\+T\+A\+NT}}
\end{DoxyParagraph}
\begin{DoxyParagraph}{Example\+:}

\begin{DoxyCode}
\textcolor{keywordflow}{if} (i.valid())
    \mbox{\hyperlink{group__string__functions_ga32070517a9f8a70a32ef48f83a6f128e}{printf}}(\textcolor{stringliteral}{"current value: %y\(\backslash\)n"}, i.getValue());
\end{DoxyCode}
 
\end{DoxyParagraph}


Implements \mbox{\hyperlink{class_qore_1_1_abstract_line_iterator_a06fc51d01bfae9f17f290ac247ffd3f3}{Qore\+::\+Abstract\+Line\+Iterator}}.

