shell/FileClass.h

   1 /* -*- Mode: C++; c-basic-offset: 4; indent-tabs-mode: nil; tab-width: 4 -*- */
   2 /* vi: set ts=4 sw=4 expandtab: (add to ~/.vimrc: set modeline modelines=5) */
   3 /* ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is [Open Source Virtual Machine.].
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Adobe System Incorporated.
  20  * Portions created by the Initial Developer are Copyright (C) 2004-2006
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Adobe AS3 Team
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #ifndef __avmshell_FileClass__
  41 #define __avmshell_FileClass__
  42
  43
  44 namespace avmshell
  45 {
  46     /**
  47      * A simple class that has some native methods.
  48      * Included as an example for writers of native methods,
  49      * and also to provide some useful QA instrumentation.
  50      */
  51     class FileClass : public avmplus::ClassClosure
  52     {
  53     public:
  54         FileClass(VTable* cvtable);
  55
  56         /**
  57          * Implementation of File.exists
  58          * AS usage: exists = File.exists(filename);
  59          * Tests whether file "filename" exists.
  60          */
  61         bool exists(Stringp filename);
  62
  63         /**
  64          * Implementation of File.read
  65          * AS usage: data = File.read(filename);
  66          * Reads the file "filename" into memory and returns
  67          * it as a string
  68          */
  69         Stringp read(Stringp filename);
  70
  71         /**
  72          * Implementation of File.write
  73          * AS usage: File.write(filename, data);
  74          * Writes the text "data" to the file "filename"
  75          */
  76         void write(Stringp filename, Stringp data);
  77
  78         ByteArrayObject* readByteArray(Stringp filename);
  79         bool writeByteArray(Stringp filename, ByteArrayObject* bytes);
  80
  81
  82         DECLARE_SLOTS_FileClass;
  83     };
  84 }
  85
  86 #endif /* __avmshell_FileClass__ */