Refactor the API

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

diff --git a/source/utils.h b/source/utils.h
index 961ad499674666629ecc7b635d04032e2b5d63ac..a6d956869bf633d531d35e24636b8b37519e35f4 100644 (file)
--- a/source/utils.h
+++ b/source/utils.h
@@ -1,44 +1,49 @@
-/*
-This file is part of libmsppath
-Copyright © 2006  Mikko Rasa, Mikkosoft Productions
+/* $Id$
+
+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_
 
-#include <sys/stat.h>
-#include <unistd.h>
-#include <list>
-#include <string>
-#include "path.h"
+#ifndef MSP_FS_UTILS_H_
+#define MSP_FS_UTILS_H_
 
 namespace Msp {
-namespace Path {
+namespace FS {
+
+class Path;
 
-struct Filename
-{
-       std::string base;
-       std::string ext;
-};
+/// Extracts the last component of the path.
+std::string basename(const Path &);
 
-extern Path fix_case(const Path &);
-extern int mkpath(const Path &, int);
-extern int rmdir(const Path &, bool =false);
-extern std::list<std::string> list_files(const Path &);
-extern bool exists(const Path &);
-extern Filename splitext(const std::string &);
-extern int fnmatch(const std::string &, const Path &);
+/// Removes the last component from the path.
+Path dirname(const 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 &);
 
-inline int stat(const Path &fn, struct stat &st)
-{ return ::stat(fn.str().c_str(), &st); }
+/**
+Returns the extension part of a filename.  This includes the last dot and
+everything after it.
+*/
+std::string extpart(const std::string &);
+
+/**
+Fixes the case of the given path to match files / directories on the
+filesystem.
+*/
+Path fix_case(const Path &path);
 
-inline Path getcwd()
-{ char buf[1024]; return ::getcwd(buf, sizeof(buf)); }
+/// Removes a file
+void unlink(const Path &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]==':'); }
+/// Makes a path relative to some base path.  That is, base/result==path.
+Path relative(const Path &path, const Path &base);
 
-} // namespace Path
+} // namespace FS
 } // namespace Msp
 
 #endif