preprocessFile: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " " to " ")
m (Text replacement - "[[Image:" to "[[File:")
 
(20 intermediate revisions by the same user not shown)
Line 24: Line 24:
|gr1= System
|gr1= System


|descr= Reads and processes the content of the specified file. Preprocessor is C-like, supports comments using // or /* and */ and [[PreProcessor Commands]]. Due to the hard-drive access this command executes and the lack of caching this command should not be used in time-critical script loops.
|descr= Reads and processes the content of the specified file. Preprocessor is C-like, supports comments using {{hl|//}} or {{hl|/*}} and {{hl|*/}} and [[PreProcessor Commands]].
{{Feature|Warning|If the file you are loading is not prepared using UTF-8 encoding and contains some characters [[toArray | with codes]] > 127, they might convert incorrectly.}}
Due to the hard-drive access this command executes and the lack of caching this command should not be used in time-critical script loops.
{{Feature|warning|If the file you are loading is not prepared using UTF-8 encoding and contains some characters [[toArray | with codes]] > 127, they might convert incorrectly.}}


|s1= '''preprocessFile''' fileName
|s1= [[preprocessFile]] fileName


|p1= fileName: [[String]] - Path to the file and name of the file
|p1= fileName: [[String]] - path to the file and name of the file


|r1= [[String]]
|r1= [[String]]


|x1= <code>_content = [[preprocessFile]] "myFunction.sqf";</code>
|x1= <sqf>_content = preprocessFile "myFunction.sqf";</sqf>


|seealso= [[fileExists ]] [[preprocessFileLineNumbers]], [[loadFile]], [[Function]], [[SQF Syntax]], [[call]], [[spawn]], [[execVM]], [[PreProcessor Commands]]
|seealso= [[fileExists]] [[preprocessFileLineNumbers]] [[loadFile]] [[Function]] [[SQF Syntax]] [[call]] [[spawn]] [[execVM]] [[PreProcessor Commands]]
}}
}}


<dl class="command_description">
{{Note
<dt><dt>
|user= Alef
<dd class="notedate">Posted on March 4, 2008</dd>
|timestamp= 20080304223500
<dt class="note">[[User:Alef|Alef]]</dt>
|text= File path is always relative to mission directory. If script dir\a.sqf includes dir\b.sqf, use "dir\b.sqf" and not "b.sqf".
<dd class="note">File path is always relative to mission directory. If script dir\a.sqf includes dir\b.sqf, use "dir\b.sqf" and not "b.sqf".
}}
<dt><dt>
 
<dd class="notedate">Posted on July 8, 2011</dd>
{{Note
<dt class="note">[[User:kju|kju]]</dt>
|user= Kju
<dd class="note">Use [[preprocessFileLineNumbers]] instead as it provides more context information on error.
|timestamp= 20110708105900
<dt><dt>
|text= Use [[preprocessFileLineNumbers]] instead as it provides more context information on error.
<dd class="notedate">Posted on December 17, 2013</dd>
}}
<dt class="note">[[User:Killzone_Kid|Killzone_Kid]]</dt>
<dd class="note">The main difference between [[preprocessFile]] and [[preprocessFileLineNumbers]] is that the latter adds #line directive to the target file, which allows to log the __LINE__ error happened at and the __FILE__ error happened in.


[[Image:PreprocessFile.jpg]]
{{Note
<dt><dt>
|user= Killzone_Kid
<dd class="notedate">Posted on July 25, 2014</dd>
|timestamp= 20131217134400
<dt class="note">[[User:BrotherhoodOfHam|BrotherhoodOfHam]]</dt>
|text= [[File:PreprocessFile.jpg|right]]The main difference between [[preprocessFile]] and [[preprocessFileLineNumbers]] is that the latter adds #line directive to the target file, which allows to log the {{hl|__LINE__}} error happened at and the {{hl|__FILE__}} error happened in.
<dd class="note"><br>Essentially what the preprocessFile command does is it refers to the contents of a file as a string:<br>
}}
Example 1:
 
<br>boop.html:
{{Note
<code><t align = 'center' valign = 'middle' shadow = '0' size = '2'>structured text</t></code>
|user= BrotherhoodOfHam
|timestamp= 20140725184300
|text= Essentially what the preprocessFile command does is it refers to the contents of a file as a string:<br>
Example 1:<br>
boop.html:
<syntaxhighlight lang="html"><t align = 'center' valign = 'middle' shadow = '0' size = '2'>structured text</t></syntaxhighlight>
init.sqf:
init.sqf:
<code>_text = [[parseText]] [[preprocessFile]] "boop.html";
<sqf>
[[hint]] _text;
_text = parseText preprocessFile "boop.html";
</code><br>
hint _text;
This is especially useful for long strings, and it works on files with any file extension as long as they can be edited with a text editor.
</sqf>
<br>
This is especially useful for long strings, and it works on files with any file extension as long as they can be edited with a text editor.<br>
Example 2:
Example 2:<br>
<br>
init.sqf:
init.sqf: <br>
<sqf>
<code>[[hint]] [[preprocessFile]] "description.ext";
hint preprocessFile "description.ext";
[[copyToClipboard]] [[preprocessFile]] "mission.sqm";
copyToClipboard preprocessFile "mission.sqm";
</code>
</sqf>
The above is all valid. However, using *.jpg or any other files saved in an image format is not possible.
The above is all valid. However, using *.jpg or any other files saved in an image format is not possible.
</dl>
}}

Latest revision as of 23:10, 20 November 2023

Logo A0.png1.85ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Reads and processes the content of the specified file. Preprocessor is C-like, supports comments using // or /* and */ and PreProcessor Commands. Due to the hard-drive access this command executes and the lack of caching this command should not be used in time-critical script loops.
⚠
If the file you are loading is not prepared using UTF-8 encoding and contains some characters with codes > 127, they might convert incorrectly.
Groups:
System

Syntax

Syntax:
preprocessFile fileName
Parameters:
fileName: String - path to the file and name of the file
Return Value:
String

Examples

Example 1:
_content = preprocessFile "myFunction.sqf";

Additional Information

See also:
fileExists preprocessFileLineNumbers loadFile Function SQF Syntax call spawn execVM PreProcessor Commands

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Alef - c
Posted on Mar 04, 2008 - 22:35 (UTC)
File path is always relative to mission directory. If script dir\a.sqf includes dir\b.sqf, use "dir\b.sqf" and not "b.sqf".
Kju - c
Posted on Jul 08, 2011 - 10:59 (UTC)
Use preprocessFileLineNumbers instead as it provides more context information on error.
Killzone_Kid - c
Posted on Dec 17, 2013 - 13:44 (UTC)
PreprocessFile.jpg
The main difference between preprocessFile and preprocessFileLineNumbers is that the latter adds #line directive to the target file, which allows to log the __LINE__ error happened at and the __FILE__ error happened in.
BrotherhoodOfHam - c
Posted on Jul 25, 2014 - 18:43 (UTC)
Essentially what the preprocessFile command does is it refers to the contents of a file as a string:
Example 1:
boop.html: 
<t align = 'center' valign = 'middle' shadow = '0' size = '2'>structured text</t>

init.sqf:

_text = parseText preprocessFile "boop.html"; hint _text;
This is especially useful for long strings, and it works on files with any file extension as long as they can be edited with a text editor.
Example 2:
init.sqf:
hint preprocessFile "description.ext"; copyToClipboard preprocessFile "mission.sqm";
The above is all valid. However, using *.jpg or any other files saved in an image format is not possible.

Retrieved from "https://community.bistudio.com/wiki?title=preprocessFile&oldid=349792"