Add rename function

[libs/core.git] / source / utils.h

diff --git a/source/utils.h b/source/utils.h
index b166fede96a8e888f4ea070cce87ede620dfe466..c582c2217ba7b489bbd43fb0801904ffb134c013 100644 (file)
--- a/source/utils.h
+++ b/source/utils.h
@@ -1,85 +1,58 @@
 /* $Id$
 
-This file is part of libmsppath
-Copyright © 2006-2007  Mikko Rasa, Mikkosoft Productions
+This file is part of libmspfs
+Copyright © 2006-2008  Mikko Rasa, Mikkosoft Productions
 Distributed under the LGPL
 */
 
-#ifndef MSP_PATH_UTILS_H_
-#define MSP_PATH_UTILS_H_
+#ifndef MSP_FS_UTILS_H_
+#define MSP_FS_UTILS_H_
 
-#include <sys/stat.h>
-#include <list>
-#include <string>
+#include "path.h"
 
 namespace Msp {
+namespace FS {
 
-class Path;
+/// Extracts the last component of the path.
+std::string basename(const Path &);
 
-struct Filename
-{
-       std::string base;
-       std::string ext;
-};
+/// Removes the last component from the path.
+Path dirname(const Path &);
 
-Path fix_case(const Path &path);
+/**
+Returns the base part of a filename.  This includes everything up to the last
+dot, but not the dot itself.
+*/
+std::string basepart(const std::string &);
 
-/// Creates a directory
-void mkdir(const Path &path, int mode);
+/**
+Returns the extension part of a filename.  This includes the last dot and
+everything after it.
+*/
+std::string extpart(const std::string &);
 
-/// Creates a directory and any required parent directories
-void mkpath(const Path &path, int mode);
+/**
+Fixes the case of the given path to match files / directories on the
+filesystem.
+*/
+Path fix_case(const Path &path);
 
-/// Removes a directory
-void rmdir(const Path &path);
+/// Reads the contents of a symbolic link
+Path readlink(const Path &path);
 
-/// Removes a directory and anything it contains
-void rmdirs(const Path &path);
+/// Resolves all symlinks from a path.  Will always return an absolute path.
+Path realpath(const Path &path);
 
 /// Removes a file
 void unlink(const Path &path);
 
-/// Lists the contents of a directory
-std::list<std::string> list_files(const Path &path);
-
-Filename splitext(const std::string &);
-int fnmatch(const std::string &, const Path &);
+/// Renames a file.  Existing file, if any, is overwritten.
+void rename(const Path &from, const Path &to);
 
 /// Makes a path relative to some base path.  That is, base/result==path.
 Path relative(const Path &path, const Path &base);
 
-std::string basename(const std::string &);
-
-/// Tests for existence of a file
-bool exists(const Path &path);
-
-/// Tests whether a path refers to an existing directory
-bool is_dir(const Path &paht);
-
-/**
-Gets information about a file.  Returns 0 on success or -1 on error.  This
-version can be used to check for file existence and get information in one
-call.
-*/
-int stat(const Path &fn, struct stat &st);
-
-/**
-Returns information about a file.  This version throws an exception if an error
-occurs.
-*/
-struct stat stat(const Path &fn);
-
-Path getcwd();
-
-/// Returns the user's home directory
-Path get_home_dir();
-
-/// Changes the current working directory
-void chdir(const Path &);
-
-inline bool is_windows_drive(const std::string &p)
-{ return (p.size()==2 && ((p[0]>='A' && p[0]<='Z') || (p[0]>='a' && p[0]<='z')) && p[1]==':'); }
-
+} // namespace FS
 } // namespace Msp
 
 #endif