mirror of
https://gitea.wildfiregames.com/0ad/0ad
synced 2026-06-16 13:23:56 -07:00
4b1297b328
Each GUI Page gets its own compartment and all ScriptInterfaces in the same thread should now use the same JS Runtime. This is required for the SpiderMonkey upgrade. Check the ticket for details. Closes #2241 Refs #1886 Refs #1966 This was SVN commit r14496.
74 lines
2.6 KiB
C++
74 lines
2.6 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 "scriptinterface/ScriptInterface.h"
|
|
|
|
// these are registered in ScriptFunctions.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.
|
|
CScriptVal BuildDirEntList(ScriptInterface::CxPrivate* pCxPrivate, std::wstring path, std::wstring filterStr, bool recurse);
|
|
|
|
// Return true iff the file exists
|
|
//
|
|
// if (fileExists(filename) { ... }
|
|
// filename: VFS filename (may include path)
|
|
bool FileExists(ScriptInterface::CxPrivate* pCxPrivate, CStrW filename);
|
|
|
|
// Return time [seconds since 1970] of the last modification to the specified file.
|
|
//
|
|
// mtime = getFileMTime(filename);
|
|
// filename: VFS filename (may include path)
|
|
double GetFileMTime(ScriptInterface::CxPrivate* pCxPrivate, std::wstring filename);
|
|
|
|
// Return current size of file.
|
|
//
|
|
// size = getFileSize(filename);
|
|
// filename: VFS filename (may include path)
|
|
unsigned int GetFileSize(ScriptInterface::CxPrivate* pCxPrivate, std::wstring filename);
|
|
|
|
// Return file contents in a string.
|
|
//
|
|
// contents = readFile(filename);
|
|
// filename: VFS filename (may include path)
|
|
CScriptVal ReadFile(ScriptInterface::CxPrivate* pCxPrivate, std::wstring filename);
|
|
|
|
// Return file contents as an array of lines.
|
|
//
|
|
// lines = readFileLines(filename);
|
|
// filename: VFS filename (may include path)
|
|
CScriptVal ReadFileLines(ScriptInterface::CxPrivate* pCxPrivate, std::wstring filename);
|
|
}
|
|
|
|
#endif
|