Reference:File I/O Directives - Revision history

Clipka: indexentry fix

2016-05-03T23:13:18Z

indexentry fix

Jholsenback: indexentry tag repair

2015-03-10T15:57:39Z

indexentry tag repair

Jholsenback: another one

2013-04-24T22:02:16Z

another one

Jholsenback: another consistency change

2013-04-24T22:00:49Z

another consistency change

Jholsenback: missed one

2013-04-24T21:54:48Z

missed one

Jholsenback: more consistency changes

2013-04-24T21:50:31Z

more consistency changes

Jholsenback: more consistency changes

2013-04-24T21:13:25Z

more consistency changes

Jholsenback: consistency change

2013-04-24T13:58:54Z

consistency change

Jholsenback: 1 revision: link repair

2012-07-23T19:27:58Z

1 revision: link repair

Jholsenback: link repair

2012-07-20T15:19:16Z

link repair

@@ Line 13: / Line 13: @@
 ==The fopen Directive==
-{{#indexentry:#fopen|fopen|append}}
+{{#indexentry:#fopen}}
 {{#indexentry:Directives, language, #fopen}}
 <p>Users may open a text file using the <code>#fopen</code> directive. The syntax is as follows:</p>
@@ Line 26: / Line 28: @@
 ==The fclose Directive==
-{{#indexentry:#fclose|fclose}}
+{{#indexentry:#fclose}}
 {{#indexentry:Directives, language, #fclose}}
 <p>Files opened with the <code>#fopen</code> directive are automatically
@@ Line 40: / Line 43: @@
 ==The read Directive==
-{{#indexentry:#read|read}}
+{{#indexentry:#read}}
 {{#indexentry:Directives, language, #read}}
 <p>You may read string, float or vector values from a plain ASCII text file directly into POV-Ray variables using the <code>#read</code> directive. The file must first be opened in <em>read</em> mode using the <code>#fopen</code> directive. The syntax for <code>#read</code> is as follows:</p>
@@ Line 64: / Line 68: @@
 ==The write Directive==
-{{#indexentry:#write|write}}
+{{#indexentry:#write}}
 {{#indexentry:Directives, language, #write}}
-{{#indexentry:uint8|sint8}}
+{{#indexentry:uint8}}
-{{#indexentry:uint16be|uint16le|sint16be|sint16le}}
+{{#indexentry:sint8}}
-{{#indexentry:sint32be|sint32le}}
+{{#indexentry:uint16be}}
 <p>You may write string, float or vector values to a plain ASCII text file from POV-Ray variables using the <code>#write</code> directive. Additionally it is now possible to write 8, 16, and 32-bit words to an external file.</p>
 <p>These words may be arranged in either little or big-endian fashion. Placing one of the following keywords in the argument list of a <code>#write</code> statement causes the values up to the next comma to be written in binary format, using 2's complement integer representation, rounded to the nearest integer in the representable range:</p>

@@ Line 12: / Line 12: @@
 provide means to restrict the ability of scene files to read and write files.</p>
 {{#indexentry:#fopen|fopen|append}}
 {{#indexentry:Directives, language, #fopen}}
 <p>Users may open a text file using the <code>#fopen</code> directive. The syntax is as follows:</p>
 <pre>
@@ Line 25: / Line 25: @@
 <p>The file handle identifier created by <code>#fopen</code> is always global and remains in effect (and the file remains open) until the scene parsing is complete or until you <code>#fclose</code> the file. You may use <code>#ifdef</code> <em>FILE_HANDLE_IDENTIFIER</em> to see if a file is open.</p>
 {{#indexentry:#fclose|fclose}}
 {{#indexentry:Directives, language, #fclose}}
 <p>Files opened with the <code>#fopen</code> directive are automatically
 closed when scene parsing completes however you may close a file using the
@@ Line 64: / Line 63: @@
 </pre>
 {{#indexentry:#write|write}}
 {{#indexentry:Directives, language, #write}}
-{{#indexentry:uint8|sint8}}{{#indexentry:uint16be|uint16le|sint16be|sint16le}}{{#indexentry:sint32be|sint32le}}
+{{#indexentry:uint8|sint8}}
 {{#indexentry:uint16be|uint16le|sint16be|sint16le}}
-==The write Directive==
+{{#indexentry:sint32be|sint32le}}
 <p>You may write string, float or vector values to a plain ASCII text file from POV-Ray variables using the <code>#write</code> directive. Additionally it is now possible to write 8, 16, and 32-bit words to an external file.</p>
 <p>These words may be arranged in either little or big-endian fashion. Placing one of the following keywords in the argument list of a <code>#write</code> statement causes the values up to the next comma to be written in binary format, using 2's complement integer representation, rounded to the nearest integer in the representable range:</p>

@@ Line 84: / Line 84: @@
 <pre>
 WRITE_DIRECTIVE:
-   #write( FILE_HANDLE_IDENTIFIER, [BINARY_WORD_TYPE,] DATA_ITEM [,DATA_ITEM]...)
+   #write (FILE_HANDLE_IDENTIFIER, [BINARY_WORD_TYPE,] DATA_ITEM [,DATA_ITEM]...)
 BINARY_WORD_TYPE:
    uint8 | sint8 | uint16be | uint16le | sint16be | sint16le | sint32be | sint32le

@@ Line 105: / Line 105: @@
 #declare Val1 = -123.45;
 #declare Vect1 = &lt;1,2,-3&gt;;
-#write(FILE_HANDLE_IDENTIFIER,&quot;\&quot;A quote delimited string\&quot;,&quot;,Val1,&quot;,&quot;,Vect1,&quot;\n&quot;)
+#write (FILE_HANDLE_IDENTIFIER,&quot;\&quot;A quote delimited string\&quot;,&quot;,Val1,&quot;,&quot;,Vect1,&quot;\n&quot;)
 </pre>
 <p>See <!--<linkto "String Literals">String Literals</linkto>--->[[Reference:Strings#String Literals|String Literals]] and <!--<linkto "String Literals">Text Formatting</linkto>--->[[Reference:User Message Directives#Text Formatting|Text Formatting]] for details on writing special characters such as quotes, newline, etc.</p>

@@ Line 54: / Line 54: @@
 <p>Where <em>FILE_HANDLE_IDENTIFIER</em> is the previously opened file. It is followed by one or more <em>DATA_IDENTIFIER</em>(s) separated by commas. The parentheses around the identifier list are required. A <em>DATA_IDENTIFIER</em> is any undeclared identifier or any previously declared string identifier, float identifier, or vector identifier. Undefined identifiers will be turned into global identifiers of the type determined by the data which is read. Previously defined identifiers remain at whatever global/local status they had when originally created. Type checking is performed to insure that the proper type data is read into these identifiers.</p>
 <p>The format of the data to be read must be a series of valid string literals, float literals, or vector literals separated by commas. Expressions or identifiers are not permitted in the data file however unary minus signs and exponential notation are permitted on float values.</p>
-<p>If you attempt to read past end-of-file, the file is automatically closed and the <em>FILE_HANDLE_IDENTIFIER</em> is deleted from the symbol table. This means that the boolean function <code>defined(</code><em>IDENTIFIER</em><code>)</code> can be used to detect end-of-file.</p>
+<p>If you attempt to read past end-of-file, the file is automatically closed and the <em>FILE_HANDLE_IDENTIFIER</em> is deleted from the symbol table. This means that the boolean function <code>defined(</code><em>FILE_HANDLE_IDENTIFIER</em><code>)</code> can be used to detect end-of-file.</p>
 <p>For example:</p>
 <pre>
@@ Line 67: / Line 67: @@
 {{#indexentry:Directives, language, #write}}
 {{#indexentry:uint8|sint8}}{{#indexentry:uint16be|uint16le|sint16be|sint16le}}{{#indexentry:sint32be|sint32le}}
 ==The write Directive==
 <p>You may write string, float or vector values to a plain ASCII text file from POV-Ray variables using the <code>#write</code> directive. Additionally it is now possible to write 8, 16, and 32-bit words to an external file.</p>

@@ Line 57: / Line 57: @@
 <p>For example:</p>
 <pre>
-#fopen MyFile &quot;mydata.txt&quot; read
+#fopen FILE_HANDLE_IDENTIFIER &quot;mydata.txt&quot; read
-#while (defined(MyFile))
+#while (defined(FILE_HANDLE_IDENTIFIER))
-   #read (MyFile,Var1,Var2,Var3)
+   #read (FILE_HANDLE_IDENTIFIER,Var1,Var2,Var3)
    ...
 #end
@@ Line 94: / Line 94: @@
 <p>For example the following <code>#read</code> directive reads a string, float and vector.</p>
 <pre>
-#read (MyFile,MyString,MyFloat,MyVect)
+#read (FILE_HANDLE_IDENTIFIER,MyString,MyFloat,MyVect)
 </pre>
 <p>It expects to read something like:</p>
@@ Line 104: / Line 104: @@
 #declare Val1 = -123.45;
 #declare Vect1 = &lt;1,2,-3&gt;;
-#write(MyFile,&quot;\&quot;A quote delimited string\&quot;,&quot;,Val1,&quot;,&quot;,Vect1,&quot;\n&quot;)
+#write(FILE_HANDLE_IDENTIFIER,&quot;\&quot;A quote delimited string\&quot;,&quot;,Val1,&quot;,&quot;,Vect1,&quot;\n&quot;)
 </pre>
 <p>See <!--<linkto "String Literals">String Literals</linkto>--->[[Reference:Strings#String Literals|String Literals]] and <!--<linkto "String Literals">Text Formatting</linkto>--->[[Reference:User Message Directives#Text Formatting|Text Formatting]] for details on writing special characters such as quotes, newline, etc.</p>

@@ Line 10: / Line 10: @@
 this feature.</p>
 <p class="Note"><strong>Note:</strong> Some platform versions of POV-Ray (e.g. Windows)
-provide means to restrict the ability of scene files to read &amp; write files.</p>
+provide means to restrict the ability of scene files to read and write files.</p>
 {{#indexentry:#fopen|fopen|append}}
@@ Line 22: / Line 22: @@
    read | write | append
 </pre>
-<p>Where <em>IDENTIFIER</em> is an undefined identifier used to reference this file as a file handle, <em>&quot;filename&quot;</em> is any string literal or string expression which specifies the file name. Files opened with the <code>read</code> are open for read only. Those opened with <code>write</code> create a new file with the specified name and it overwrites any existing file with that name. Those opened with <code>append</code> opens a file for writing but appends the text to the end of any existing file.</p>
+<p>Where <em>FILE_HANDLE_IDENTIFIER</em> is an undefined identifier used to reference this file as a file handle, <em>&quot;filename&quot;</em> is any string literal or string expression which specifies the file name. Files opened with the <code>read</code> are open for read only. Those opened with <code>write</code> create a new file with the specified name and it overwrites any existing file with that name. Those opened with <code>append</code> opens a file for writing but appends the text to the end of any existing file.</p>
 <p>The file handle identifier created by <code>#fopen</code> is always global and remains in effect (and the file remains open) until the scene parsing is complete or until you <code>#fclose</code> the file. You may use <code>#ifdef</code> <em>FILE_HANDLE_IDENTIFIER</em> to see if a file is open.</p>
@@ Line 38: / Line 38: @@
 <p>Where <em>FILE_HANDLE_IDENTIFIER</em> is previously opened file opened
-with the <code>#fopen</code> directive. See [[Reference:File I/O Directives#The fopen Directive|:#fopen|The #fopen Directive]].</p>
+with the <code>#fopen</code> directive.</p>
 ==The read Directive==
@@ Line 52: / Line 52: @@
 </pre>
-<p>Where <em>FILE_HANDLE_IDENTIFIER</em> is the previously opened file. It is followed by one or more <em>DATA_IDENTIFIER</em>s separated by commas. The parentheses around the identifier list are required. A <em>DATA_IDENTIFIER</em> is any undeclared identifier or any previously declared string identifier, float identifier, or vector identifier. Undefined identifiers will be turned into global identifiers of the type determined by the data which is read. Previously defined identifiers remain at whatever global/local status they had when originally created. Type checking is performed to insure that the proper type data is read into these identifiers.</p>
+<p>Where <em>FILE_HANDLE_IDENTIFIER</em> is the previously opened file. It is followed by one or more <em>DATA_IDENTIFIER</em>(s) separated by commas. The parentheses around the identifier list are required. A <em>DATA_IDENTIFIER</em> is any undeclared identifier or any previously declared string identifier, float identifier, or vector identifier. Undefined identifiers will be turned into global identifiers of the type determined by the data which is read. Previously defined identifiers remain at whatever global/local status they had when originally created. Type checking is performed to insure that the proper type data is read into these identifiers.</p>
 <p>The format of the data to be read must be a series of valid string literals, float literals, or vector literals separated by commas. Expressions or identifiers are not permitted in the data file however unary minus signs and exponential notation are permitted on float values.</p>
 <p>If you attempt to read past end-of-file, the file is automatically closed and the <em>FILE_HANDLE_IDENTIFIER</em> is deleted from the symbol table. This means that the boolean function <code>defined(</code><em>IDENTIFIER</em><code>)</code> can be used to detect end-of-file.</p>
@@ Line 89: / Line 89: @@
    FLOAT | VECTOR | STRING
 </pre>
-<p>Where <em>FILE_HANDLE_IDENTIFIER</em> is the previously opened file. It is followed by one or more  <em>DATA_ITEM</em>s separated by commas. The parentheses around the identifier list are required. A <em>DATA_ITEM</em> is any valid string expression, float expression, or vector expression. Float expressions are evaluated and written as signed float literals. If you require format control, you should use the <code>str(VALUE,L,P)</code> function to convert it to a formatted string. See <!--<linkto "String Functions">String Functions</linkto>--->[[Reference:Strings#String Functions|String Functions]] for details on the <code>str</code> function. Vector expressions are evaluated into three signed float constants and are written with angle brackets and commas in standard POV-Ray vector notation. String expressions are evaluated and written as specified.</p>
+<p>Where <em>FILE_HANDLE_IDENTIFIER</em> is the previously opened file. It is followed by one or more  <em>DATA_ITEM</em>(s) separated by commas. The parentheses around the identifier list are required. A <em>DATA_ITEM</em> is any valid string expression, float expression, or vector expression. Float expressions are evaluated and written as signed float literals. If you require format control, you should use the <code>str(VALUE,L,P)</code> function to convert it to a formatted string. See <!--<linkto "String Functions">String Functions</linkto>--->[[Reference:Strings#String Functions|String Functions]] for details on the <code>str</code> function. Vector expressions are evaluated into three signed float constants and are written with angle brackets and commas in standard POV-Ray vector notation. String expressions are evaluated and written as specified.</p>
 <p class="Note"><strong>Note:</strong> Data read by the <code>#read</code> directive must have comma
 delimiters between values and quotes around string data but the <code>#write</code> directive does not automatically output commas or quotes.</p>

@@ Line 18: / Line 18: @@
 <pre>
 FOPEN_DIRECTIVE:
-   #fopen IDENTIFIER &quot;filename&quot; OPEN_TYPE
+   #fopen FILE_HANDLE_IDENTIFIER &quot;filename&quot; OPEN_TYPE
 OPEN_TYPE:
    read | write | append
@@ Line 27: / Line 27: @@
 {{#indexentry:#fclose|fclose}}
 {{#indexentry:Directives, language, #fclose}}
 ==The fclose Directive==
 <p>Files opened with the <code>#fopen</code> directive are automatically

← Older revision	Revision as of 19:27, 23 July 2012
(No difference)