0ad/source/ps/scripting/JSInterface_VFS.h
Yves 93cffe9deb Remove the old and no longer used archive builder that rebuilt the archive while the game is running.
This approach isn't used anymore. Now we start the archive building with
parameters to pyrogeneis.

Refs #2241 (the code used g_ScriptingHost which is going to be removed)

This was SVN commit r14102.
2013-11-07 21:06:18 +00:00

75 lines
2.4 KiB
C++

/* Copyright (C) 2009 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* 0 A.D. is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
*/
// JSInterface_VFS.h
//
// The JavaScript wrapper around useful snippets of the VFS
#ifndef INCLUDED_JSI_VFS
#define INCLUDED_JSI_VFS
#include "scripting/ScriptingHost.h"
// these are registered in ScriptGlue.cpp, hence the need for a header.
namespace JSI_VFS
{
// Return an array of pathname strings, one for each matching entry in the
// specified directory.
//
// pathnames = buildDirEntList(start_path [, filter_string [, recursive ] ]);
// directory: VFS path
// filter_string: see match_wildcard; "" matches everything.
// recurse: should subdirectories be included in the search? default false.
//
// note: full pathnames of each file/subdirectory are returned,
// ready for use as a "filename" for the other functions.
JSBool BuildDirEntList(JSContext* cx, uintN argc, jsval* vp);
// Return true iff the file exists
//
// if (fileExists(filename) { ... }
// filename: VFS filename (may include path)
JSBool FileExists(JSContext* cx, uintN argc, jsval* vp);
// Return time [seconds since 1970] of the last modification to the specified file.
//
// mtime = getFileMTime(filename);
// filename: VFS filename (may include path)
JSBool GetFileMTime(JSContext* cx, uintN argc, jsval* vp);
// Return current size of file.
//
// size = getFileSize(filename);
// filename: VFS filename (may include path)
JSBool GetFileSize(JSContext* cx, uintN argc, jsval* vp);
// Return file contents in a string.
//
// contents = readFile(filename);
// filename: VFS filename (may include path)
JSBool ReadFile(JSContext* cx, uintN argc, jsval* vp);
// Return file contents as an array of lines.
//
// lines = readFileLines(filename);
// filename: VFS filename (may include path)
JSBool ReadFileLines(JSContext* cx, uintN argc, jsval* vp);
}
#endif