filesystem_utils.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
** 
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
** 
**     http://www.apache.org/licenses/LICENSE-2.0
** 
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
 
#ifndef FILESYSTEM_H
#define FILESYSTEM_H
 
#include <time.h>
 
#include "typedefs.h"
#include "linked_list.h"
#include "grassroots_util_library.h"
 
 
typedef struct FileInformation
{
  time_t fi_last_modified;
 
  size_t fi_size;
} FileInformation;
 
 
 
#ifdef __cplusplus
  extern "C" {
#endif
 
 
 
GRASSROOTS_UTIL_API void InitFileInformation (FileInformation *info_p);
 
 
GRASSROOTS_UTIL_API bool CalculateFileInformation (const char * const path_s, FileInformation *info_p);
 
 
GRASSROOTS_UTIL_API char *GetFilenameOnly (const char * const full_path_to_file_s);
 
 
GRASSROOTS_UTIL_API char *GetPathOnly (const char * const full_path_to_file_s);
 
 
GRASSROOTS_UTIL_API char *MakeFilename (const char * const path_s, const char * const filename_s);
 
 
 
GRASSROOTS_UTIL_API bool DeterminePathAndFile (const char * const full_path_s, char ** const path_ss, char ** const filename_ss);
 
 
GRASSROOTS_UTIL_API char *SetFileExtension (const char * const filename_s, const char * const extension_s, bool replace_flag);
 
 
GRASSROOTS_UTIL_API void UsePlatformFileSeparator (char *value_s);
 
 
GRASSROOTS_UTIL_API bool IsPathValid (const char * const path_s);
 
 
GRASSROOTS_UTIL_API bool IsPathAbsolute (const char * const path_s);
 
 
GRASSROOTS_UTIL_API LinkedList *GetMatchingFiles (const char * const pattern_s, const bool full_path_flag);
 
 
GRASSROOTS_UTIL_API char GetFileSeparatorChar (void);
 
 
GRASSROOTS_UTIL_API const char *GetCurrentDirectoryString (void);
 
 
GRASSROOTS_UTIL_API const char *GetParentDirectory (void);
 
 
GRASSROOTS_UTIL_API const char *GetPluginPattern (void);
 
 
GRASSROOTS_UTIL_API bool EnsureDirectoryExists (const char * const path_s);
 
 
GRASSROOTS_UTIL_API bool CopyToNewFile (const char * const src_filename_s, const char * const dest_filename_s, void (*callback_fn) (void));
 
 
GRASSROOTS_UTIL_API bool SetCurrentWorkingDirectory (const char * const path_s);
 
 
GRASSROOTS_UTIL_API char *GetCurrentWorkingDirectory (void);
 
 
 
GRASSROOTS_UTIL_API char *GetHomeDirectory (void);
 
GRASSROOTS_UTIL_API bool IsDirectory (const char * const path_s);
 
 
GRASSROOTS_UTIL_API bool RemoveFile (const char * const path_s);
 
 
GRASSROOTS_UTIL_API bool DoesFileExist (const char * const path_s);
 
 
#ifdef __cplusplus
}
#endif
 
#endif  /* FILESYSTEM_H */