mirror of
https://gitea.wildfiregames.com/0ad/0ad
synced 2026-06-16 05:13:58 -07:00
1a66f510d0
Using references matches the C++ coding style better and should improve performance a bit in theory. It avoids 2 copies of T in case of the functions registered with RegisterFunction (mainy used in the GUI). It should also avoid one or two copies in case of DEFINE_INTERFACE_METHOD_X, which is used in the simulation, but I haven't bothered to count it there exactly. It is now predefined which types have to be passed by const reference and which are passed by value. Note that references can't be used as out-parameters (to return multiple values to JS). This hasn't worked before either and probably never will. This was SVN commit r17696.
74 lines
2.7 KiB
C++
74 lines
2.7 KiB
C++
/* Copyright (C) 2014 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.
|
|
JS::Value BuildDirEntList(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& path, const 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, const 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, const std::wstring& filename);
|
|
|
|
// Return current size of file.
|
|
//
|
|
// size = getFileSize(filename);
|
|
// filename: VFS filename (may include path)
|
|
unsigned int GetFileSize(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& filename);
|
|
|
|
// Return file contents in a string.
|
|
//
|
|
// contents = readFile(filename);
|
|
// filename: VFS filename (may include path)
|
|
JS::Value ReadFile(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& filename);
|
|
|
|
// Return file contents as an array of lines.
|
|
//
|
|
// lines = readFileLines(filename);
|
|
// filename: VFS filename (may include path)
|
|
JS::Value ReadFileLines(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& filename);
|
|
}
|
|
|
|
#endif
|