HelpSource/Classes/File.schelp

   1 class:: File
   2 summary:: A class for reading and writing files
   3 related:: Classes/FileReader
   4 categories:: Files
   5
   6 description::
   7 A class for reading and writing files. Not sound files.
   8
   9 ClassMethods::
  10
  11 private::prGetcwd, prType
  12
  13 method::new
  14 Create a File instance and open the file. If the open fails, link::Classes/UnixFILE#-isOpen#isOpen:: will return false.
  15
  16 argument::pathname
  17 a link::Classes/String:: containing the path name of the file to open.
  18
  19 argument::mode
  20 a link::Classes/String:: indicating one of the following modes:
  21 definitionList::
  22 ## "r" || Opens a file for reading. The file must exist.
  23 ## "w" || Creates an empty file for writing. If a file with the same name already exists its content is erased and thefile is treated as a new empty file.
  24 ## "a" || Appends to a file. Writing operations append data at the end of the file. The file is created if it does not exist.
  25 ## "rb", "wb", "ab" || same as above, but data is binary
  26 ## "r+" || Opens a file for update both reading and writing. The file must exist.
  27 ## "w+" || Creates an empty file for both reading and writing. If a file with the same name already exists its content is erased and the file is treated as a new empty file.
  28 ## "a+" || Opens a file for reading and appending. All writing operations are performed at the end of the file, protecting the previous content to be overwritten. You can reposition the internal pointer using the seek method to anywhere in the file for reading, but writing operations will move it back to the end of file. The file is created if it does not exist.
  29 ## "rb+", wb+", "ab+" || same as above, but data is binary
  30 ::
  31
  32 method::open
  33 same as link::#*new::, but a more intuitive name.
  34
  35 method::getcwd
  36 POSIX standard 'get current working directory'.
  37 code::
  38 // example;
  39 File.getcwd;
  40 ::
  41
  42 method::use
  43 open the file, evaluate the function with the file and close it.
  44
  45 subsection:: Filesystem utilities
  46
  47 method::exists
  48 answers if a file exists at that path.
  49 returns:: a link::Classes/Boolean::
  50
  51 method::mkdir
  52 create directory at path, including any missing parent directories.
  53
  54 method::delete
  55 deletes the file at that path. Use only for good, never for evil.
  56
  57 method::realpath
  58 follow symbolic links (and aliases on OSX) and any parent directory references (like "..") and return the true absolute path.
  59 returns:: a link::Classes/String:: or code::nil:: if path did not exist.
  60
  61 method::copy
  62 copy file, symlink or directory. this method will fail if pathNameTo already exists.
  63
  64 symlinks are copied as symlinks (re-created).
  65
  66 method::type
  67 get file type as one of code::\error, \not_found, \regular, \directory, \symlink, \block, \character, \fifo, \socket, \unknown::
  68 returns:: a link::Classes/Symbol::
  69
  70 method::fileSize
  71 get size of file in bytes.
  72 returns:: an link::Classes/Integer::
  73
  74 method::mtime
  75 get last modification time in seconds since the Epoch.
  76 returns:: an link::Classes/Integer::
  77
  78
  79 InstanceMethods::
  80
  81 private::prOpen, prClose
  82
  83 method::open
  84 Open the file. Files are automatically opened upon creation, so this call is only necessary if you are closing and opening the same file object repeatedly.
  85 note::
  86 it is possible when saving files with a standard file dialog to elect to "hide the extension" and save it as RTF. When opening the file you must specify the real filename: "filename.rtf", even though you can't see in file load dialogs or in the Finder.
  87 ::
  88
  89 method::close
  90 Close the file.
  91
  92 method::readAllString
  93 Reads the entire file as a link::Classes/String::.
  94
  95 method::readAllStringRTF
  96 Reads the entire file as a link::Classes/String::, stripping RTF formatting.
  97
  98 method::seek
  99 moves the read/write pointer to a given location in the file, where offset is location given in bytes, and origin is the reference of the offset:
 100 definitionList::
 101 ## 0 || offset is from the beginning of the file
 102 ## 1 || offset is relative to the current position in the file
 103 ## 2 || offset is from the end of the file
 104 ::
 105
 106 method::pos
 107 sets or returns the current position in the file (in bytes).
 108 when used as a setter, this method is a shortcut for seek(0, value). so setting the pos moves the current file position to a given location from the beginning of the file. the value is clipped so that it lies between 0 inclusively and the file length exclusively.
 109
 110 method::length
 111 returns the current file size in bytes.
 112
 113 Examples::
 114
 115 code::
 116 // write some string to a file:
 117 (
 118 var f, g;
 119 f = File("test","w");
 120 f.write("Does this work?\n is this thing on ?\n");
 121 f.close;
 122 )
 123
 124 // read it again:
 125 (
 126 g = File("test","r");
 127 g.readAllString.postln;
 128 g.close;
 129 )
 130
 131 // try the above with File.use:
 132
 133 File.use("test", "w", { |f| f.write("Doesn't this work?\n is this thing really on ?\n"); });
 134 File.use("test", "r", { |f| f.readAllString.postln });
 135
 136
 137 // more file writing/reading examples:
 138 (
 139 var h, k;
 140 h = File("test2", "wb");
 141 h.inspect;
 142 h.write( FloatArray[1.1, 2.2, 3.3, pi, 3.sqrt] );
 143 h.close;
 144
 145 k = File("test2", "rb");
 146 (k.length div: 4).do({ k.getFloat.postln; });
 147 k.close;
 148 )
 149
 150
 151 (
 152 var f, g;
 153 f = File("test3","w");
 154 100.do({ f.putChar([$a, $b, $c, $d, $e, $\n].choose); });
 155 f.close;
 156
 157 g = File("test3","r");
 158 g.readAllString.postln;
 159 g.close;
 160
 161 g = File("test3","r");
 162 g.getLine(1024).postln;
 163 "*".postln;
 164 g.getLine(1024).postln;
 165 "**".postln;
 166 g.getLine(1024).postln;
 167 "***".postln;
 168 g.getLine(1024).postln;
 169 "****".postln;
 170 g.close;
 171 )
 172
 173 (
 174 //var f, g;
 175 f = File("test3","wb");
 176 f.inspect;
 177 100.do({ f.putFloat(1.0.rand); });
 178
 179 f.inspect;
 180 f.close;
 181
 182 g = File("test3","rb");
 183 100.do({
 184         g.getFloat.postln;
 185 });
 186 g.inspect;
 187 g.close;
 188 )
 189
 190 (
 191 //var f, g;
 192 f = File("test3","r");
 193 f.inspect;
 194 f.getLine(1024).postln;
 195 f.close;
 196 )
 197 ::