Skip to content

/ mantid

Permalink
Browse files

Small changes to the ScriptRepository interface for improvement 

Attempt to improve the interface for the sake of performance. Otherwise,
plenty of copy of strings will be made that are useless.

re #6177
  • Loading branch information
@gesnerpassos
gesnerpassos committed Apr 16, 2013
1 parent fee4d9d commit 2c291ece8559905907f15f6f001a5cad3654f5fb
66 Code/Mantid/Framework/API/inc/MantidAPI/ScriptRepository.h
View file
@@ -20,12 +20,12 @@ namespace API{
{
/// Identification of the author of the script.
std::string author;
/// Description of the purpose of the script @see @ref ScriptRepositoryDescription
std::string description;
/// Time of the last update of this file (remotelly)
Kernel::DateAndTime pub_date;
/// Marked for auto update
bool auto_update;
/// Directory Flag to indicate if the entry is a directory.
bool directory;
};

/** Represent the possible states for a given file:
@@ -95,19 +95,19 @@ namespace API{

public:
///default constructor
ScriptRepoException(const std::string info = std::string("Unknown Exception")):
ScriptRepoException(const std::string & info = std::string("Unknown Exception")):
_system_error(""),
_user_info(info),
_file_path(""){
};

ScriptRepoException( int err_, const std::string info = std::string(),
const std::string file = std::string(),
ScriptRepoException( int err_, const std::string & info = std::string(),
const std::string & file = std::string(),
int line = -1);

ScriptRepoException(const std::string info ,
const std::string system,
const std::string file = std::string(),
ScriptRepoException(const std::string & info ,
const std::string & system,
const std::string & file = std::string(),
int line = -1);


@@ -292,18 +292,7 @@ They will work as was expected for folders @ref folders-sec.
class MANTID_API_DLL ScriptRepository
{
public:
/// @deprecated Define a file inside the repository
struct file_entry
{
/// path related to git
std::string path;
/// file status
SCRIPTSTATUS status;
/// show if it is a directory or not
bool directory;
};


/// Virtual destructor (always needed for abstract classes)
virtual ~ScriptRepository() {};

@@ -321,12 +310,20 @@ They will work as was expected for folders @ref folders-sec.
@code
ScriptSharing spt;
ScriptInfo info = spt.info("README.md");
// info.description : returns the file description.
// info.author : returns the file author.
@endcode
*/
virtual ScriptInfo info(const std::string path) = 0;
virtual ScriptInfo info(const std::string & path) = 0;

/** Provide the description of the file given the path
*
* @param path: Script path related to the reposititory, or the operative system.
* @return the description of the file or folder.
*/
virtual const std::string& description(const std::string & path) = 0;

/// @deprecated Previous version, to be removed.
ScriptInfo fileInfo(const std::string path){return info(path);}
ScriptInfo fileInfo(const std::string & path){return info(path);}


/**
@@ -367,7 +364,6 @@ They will work as was expected for folders @ref folders-sec.
@exception May throw Invalid Repository if the local repository was not generated. In this case, it is necessary to execute the ScriptRepository::install (at least once).
*/
virtual std::vector<std::string> listFiles() = 0;
const std::vector<struct file_entry> & listEntries() {return repository_list;}

/**
Create a copy of the remote file/folder inside the local repository.
@@ -386,7 +382,7 @@ They will work as was expected for folders @ref folders-sec.
remotely or to indicate that a conflict was found.
*/
virtual void download(const std::string file_path) = 0 ;
virtual void download(const std::string & file_path) = 0 ;



@@ -398,7 +394,7 @@ They will work as was expected for folders @ref folders-sec.
@return SCRIPTSTATUS : of the given file/folder
@exception ScriptRepoException to indicate that file is not available.
*/
virtual SCRIPTSTATUS fileStatus(const std::string file_path) = 0;
virtual SCRIPTSTATUS fileStatus(const std::string & file_path) = 0;


/** Check if the local repository exists. If there is no local repository,
@@ -419,7 +415,7 @@ They will work as was expected for folders @ref folders-sec.
@exception ScriptRepoException: If the local_path may not be created (Permission issues).
*/
virtual void install(std::string local_path) = 0;
virtual void install(const std::string & local_path) = 0;

/** Allow the ScriptRepository to double check the connection with the web server.
An optional argument is allowed webserverurl, but, it may be taken from the settings defined for the ScriptRepository.
@@ -429,7 +425,7 @@ They will work as was expected for folders @ref folders-sec.
@param webserverurl : url of the mantid web server.
@exception ScriptRepoException: Failure to connect to the web server and the reason why.
*/
virtual void connect(std::string webserverurl = "") = 0;
virtual void connect(const std::string & webserverurl = "") = 0;

/**
Connects to the remote repository checking for updates.
@@ -447,9 +443,6 @@ They will work as was expected for folders @ref folders-sec.
may eventually, notify that the local repository may not be created.
*/
virtual void check4Update(void) = 0;
/// @deprecated Used in the previous version. Use check4Update instead.
void update(void) {check4Update();};



/**
@@ -491,9 +484,9 @@ They will work as was expected for folders @ref folders-sec.
*/
virtual void upload(const std::string file_path, const std::string comment,
const std::string author,
const std::string description = std::string()) = 0;
virtual void upload(const std::string & file_path, const std::string & comment,
const std::string & author,
const std::string & description = std::string()) = 0;

/** Define the file patterns that will not be listed in listFiles.
This is important to force the ScriptRepository to not list hidden files,
@@ -512,7 +505,7 @@ They will work as was expected for folders @ref folders-sec.
This settings must be preserved, and be available after trough the configure system.
*/
virtual void setIgnorePatterns(std::string patterns) = 0;
virtual void setIgnorePatterns(const std::string & patterns) = 0;

/** Return the ignore patters that was defined through ScriptRepository::setIgnorePatterns*/
virtual std::string ignorePatterns(void) = 0;
@@ -530,12 +523,9 @@ They will work as was expected for folders @ref folders-sec.
@exception ScriptRepoException : Invalid entry.
*/
virtual void setAutoUpdate(std::string path, bool option = true) = 0;
virtual void setAutoUpdate(const std::string & path, bool option = true) = 0;


protected:
/// @deprecated get all the files from a repository
std::vector<struct file_entry> repository_list;
};

///shared pointer to the function base class
10 Code/Mantid/Framework/API/src/ScriptRepository.cpp
View file
@@ -8,8 +8,8 @@ namespace Mantid
{

ScriptRepoException::ScriptRepoException( int err_,
const std::string info,
const std::string file,
const std::string & info,
const std::string & file,
int line )
{
if (err_)
@@ -35,9 +35,9 @@ namespace Mantid
}
}

ScriptRepoException::ScriptRepoException( const std::string info,
const std::string system,
const std::string file ,
ScriptRepoException::ScriptRepoException( const std::string &info,
const std::string &system,
const std::string &file ,
int line)
{
_system_error = system;
22 Code/Mantid/Framework/PythonInterface/mantid/api/src/Exports/ScriptRepository.cpp
View file
@@ -41,12 +41,12 @@ namespace
return registered;
}

tuple getInfo(ScriptRepository & self, const std::string path){
tuple getInfo(ScriptRepository & self, const std::string & path){
ScriptInfo info = self.info(path);
return boost::python::make_tuple<std::string>(info.author, info.description, info.pub_date.toSimpleString() );
return boost::python::make_tuple<std::string>(info.author, info.pub_date.toSimpleString() );
}

PyObject * getStatus(ScriptRepository & self, const std::string path){
PyObject * getStatus(ScriptRepository & self, const std::string & path){
SCRIPTSTATUS st = self.fileStatus(path);
PyObject * value;
switch(st){
@@ -75,6 +75,12 @@ namespace
return value;
}

PyObject * getDescription(ScriptRepository & self, const std::string & path){
PyObject * value;
value = PyString_FromString(self.description(path).c_str());
return value;
}

/** @endcond */
}

@@ -129,7 +135,14 @@ const char * file_info_desc =
The author, description and publication date are available through this method. \n\
\n\
:param path: Path to the entry.\n\
:return : Tuple with (author, description, last publication date)\n";
:return : Tuple with (author, last publication date)\n";

const char * file_description_desc =
"Return description of the entry inside ScriptRepository. \n\
\n\
:param path: Path to the entry.\n\
:return : String with the description \n";


const char * file_status_desc =
"Return the status of a given entry.\n\
@@ -179,6 +192,7 @@ ScriptRepository will install itself.";
.def("install",&ScriptRepository::install, install_desc)
.def("listFiles",&getListFiles, list_files_desc)
.def("fileInfo",&getInfo,file_info_desc)
.def("description",&getDescription,file_description_desc)
.def("fileStatus",&getStatus,file_status_desc)
.def("download",&ScriptRepository::download,download_desc)
//.def("upload",&ScriptRepository::upload, "")
35 Code/Mantid/Framework/ScriptRepository/inc/MantidScriptRepository/ScriptRepositoryImpl.h
View file
@@ -79,45 +79,46 @@ namespace API{
Repository repo;

public:
ScriptRepositoryImpl(const std::string local_repository = std::string(),
const std::string remote_url = std::string()) ;
ScriptRepositoryImpl(const std::string & local_repository = std::string(),
const std::string & remote_url = std::string()) ;

virtual ~ScriptRepositoryImpl() throw();

void connect(std::string server);
void connect(const std::string & server);

void install(std::string local_path);
void install(const std::string & local_path);

ScriptInfo info(const std::string path);
ScriptInfo info(const std::string & path);
const std::string & description(const std::string & path);

std::vector<std::string> listFiles();

void download(const std::string file_path);
void download(const std::string & file_path);

SCRIPTSTATUS fileStatus(const std::string file_path);
SCRIPTSTATUS fileStatus(const std::string & file_path);

void upload(const std::string file_path, const std::string comment,
const std::string author,
const std::string description = std::string());
void upload(const std::string & file_path, const std::string & comment,
const std::string & author,
const std::string & description = std::string());

/* Return true if there is a local repository installed*/
bool isValid(void);

void check4Update(void);

void setIgnorePatterns(std::string patterns);
void setIgnorePatterns(const std::string & patterns);

std::string ignorePatterns(void);

void setAutoUpdate(std::string path, bool option = true);
void setAutoUpdate(const std::string & path, bool option = true);

/// @deprecated Should avoid this, it is not in the design file.
std::string localRepository() const {return local_repository; }




virtual void doDownloadFile(const std::string url_file, const std::string local_file_path = "");
virtual void doDownloadFile(const std::string & url_file, const std::string & local_file_path = "");
protected:
void parseCentralRepository(Repository & repo);

@@ -128,7 +129,7 @@ namespace API{
void ensureValidRepository();


bool isEntryValid(std::string path);
bool isEntryValid(const std::string & path);

/// Path of the local repository.
std::string local_repository;
@@ -139,7 +140,7 @@ namespace API{
private:
void recursiveParsingDirectories(const std::string & path, Repository & repo);

std::string convertPath(const std::string path);
std::string convertPath(const std::string & path);

/* /// Used to throw when a local repository is mal-formed.
ScriptRepoException invalidRepository();
@@ -158,8 +159,8 @@ namespace API{
private:

static std::string printStatus(SCRIPTSTATUS st);
void download_directory(const std::string);
void download_file(const std::string, RepositoryEntry & );
void download_directory(const std::string&);
void download_file(const std::string& , RepositoryEntry & );
void updateLocalJson(const std::string & , const RepositoryEntry & );

/// reference to the logger class

0 comments on commit 2c291ec

Please sign in to comment.
You can’t perform that action at this time.