path.h

Go to the documentation of this file.

/* Copyright (c) 2021 Connected Way, LLC. All rights reserved.
 * Use of this source code is governed by a Creative Commons 
 * Attribution-NoDerivatives 4.0 International license that can be
 * found in the LICENSE file.
 */
#if !defined(__OFC_PATH_H__)
#define __OFC_PATH_H__
 
#include "ofc/core.h"
#include "ofc/types.h"
#include "ofc/config.h"
#include "ofc/file.h"
 
typedef OFC_VOID OFC_PATH;
 
 
#if defined(__cplusplus)
extern "C"
{
#endif
OFC_CORE_LIB OFC_VOID
ofc_path_init(OFC_VOID);
OFC_CORE_LIB OFC_VOID
ofc_path_destroy(OFC_VOID);
OFC_CORE_LIB OFC_BOOL
ofc_path_add_mapW(OFC_LPCTSTR lpDevice, OFC_LPCTSTR lpDesc,
                  OFC_PATH *map, OFC_FST_TYPE fsType, OFC_BOOL thumbnail);
OFC_CORE_LIB OFC_BOOL
ofc_path_add_mapA(OFC_LPCSTR lpDevice, OFC_LPCSTR lpDesc,
                  OFC_PATH *map, OFC_FST_TYPE fsType, OFC_BOOL thumbnail);
OFC_CORE_LIB OFC_PATH *
ofc_path_createW(OFC_LPCTSTR lpFileName);
OFC_CORE_LIB OFC_PATH *
ofc_path_createA(OFC_LPCSTR lpFileName);
 
OFC_CORE_LIB OFC_PATH *
ofc_path_init_path(OFC_VOID);
OFC_CORE_LIB OFC_VOID
ofc_path_update(OFC_PATH *path, OFC_PATH *map);
OFC_CORE_LIB OFC_SIZET
ofc_path_printW(OFC_PATH *path, OFC_LPTSTR *filename, OFC_SIZET *rem);
OFC_CORE_LIB OFC_SIZET
ofc_path_printA(OFC_PATH *path, OFC_LPSTR *filename, OFC_SIZET *rem);
OFC_CORE_LIB OFC_TCHAR *ofc_path_print_alloc(OFC_PATH *path);
 
OFC_CORE_LIB OFC_SIZET
ofc_path_make_urlW(OFC_LPTSTR *filename,
                   OFC_SIZET *rem,
                   OFC_LPCTSTR username,
                   OFC_LPCTSTR password,
                   OFC_LPCTSTR domain,
                   OFC_LPCTSTR server,
                   OFC_LPCTSTR share,
                   OFC_LPCTSTR path,
                   OFC_LPCTSTR file);
OFC_CORE_LIB OFC_SIZET
ofc_path_make_urlA(OFC_LPSTR *filename,
                   OFC_SIZET *rem,
                   OFC_LPCSTR username,
                   OFC_LPCSTR password,
                   OFC_LPCSTR domain,
                   OFC_LPCSTR server,
                   OFC_LPCSTR share,
                   OFC_LPCSTR path,
                   OFC_LPCSTR file);
OFC_CORE_LIB OFC_VOID
ofc_path_delete(OFC_PATH *path);
OFC_CORE_LIB OFC_VOID
ofc_path_mapW(OFC_LPCTSTR lpFileName, OFC_LPTSTR *lppMappedName,
              OFC_FST_TYPE *filesystem);
OFC_CORE_LIB OFC_VOID
ofc_path_mapA(OFC_LPCSTR lpFileName, OFC_LPSTR *lppMappedName,
              OFC_FST_TYPE *filesystem);
 
#if 0
OFC_CORE_LIB OFC_VOID
ofc_root_path_mapW(OFC_LPCTSTR lpRootPath, OFC_LPTSTR *lppMappedPath,
          OFC_FS_TYPE *filesystem) ;
OFC_CORE_LIB OFC_VOID
ofc_root_path_mapA(OFC_LPCSTR lpRootPath, OFC_LPSTR *lppMappedPath,
          OFC_FS_TYPE *filesystem) ;
#endif
OFC_CORE_LIB OFC_VOID
ofc_path_delete_mapW(OFC_LPCTSTR lpVirtual);
OFC_CORE_LIB OFC_VOID
ofc_path_delete_mapA(OFC_LPCSTR lpVirtual);
OFC_CORE_LIB OFC_PATH *
ofc_path_map_deviceW(OFC_LPCTSTR lpDevice);
OFC_CORE_LIB OFC_PATH *
ofc_path_map_deviceA(OFC_LPCSTR lpDevice);
 
#define AUTHENTICATE
#if defined(AUTHENTICATE)
OFC_CORE_LIB OFC_VOID
ofc_path_update_credentialsW(OFC_LPCTSTR filename, OFC_LPCTSTR username,
                             OFC_LPCTSTR password, OFC_LPCTSTR domain);
OFC_CORE_LIB OFC_VOID
ofc_path_update_credentialsA(OFC_LPCSTR filename, OFC_LPCSTR username,
                             OFC_LPCSTR password, OFC_LPCSTR domain);
 
#else
OFC_CORE_LIB OFC_VOID
ofc_path_update_credentialsW(OFC_PATH *path, OFC_LPCTSTR username,
                OFC_LPCTSTR password, OFC_LPCTSTR domain) ;
OFC_CORE_LIB OFC_VOID
ofc_path_update_credentialsA(OFC_PATH *path, OFC_LPCSTR username,
                OFC_LPCSTR password, OFC_LPCSTR domain) ;
#endif
OFC_BOOL ofc_path_is_wild(OFC_LPCTSTR dir);
OFC_CORE_LIB OFC_VOID
ofc_path_get_rootW(OFC_CTCHAR *lpFileName, OFC_TCHAR **lpRootName,
                   OFC_FST_TYPE *filesystem);
OFC_CORE_LIB OFC_VOID
ofc_path_get_rootA(OFC_CCHAR *lpFileName, OFC_CHAR **lpRootName,
                   OFC_FST_TYPE *filesystem);
 
OFC_CORE_LIB OFC_VOID
ofc_path_get_mapW(OFC_INT idx, OFC_LPCTSTR *lpDevice,
                  OFC_LPCTSTR *lpDesc, OFC_PATH **map,
                  OFC_BOOL *thumbnail);
 
OFC_CORE_LIB OFC_PATH *ofc_map_path(OFC_LPCTSTR lpFileName,
                                    OFC_LPTSTR *lppMappedName);
 
OFC_CORE_LIB OFC_BOOL ofc_path_remote(OFC_PATH *path);
OFC_CORE_LIB OFC_BOOL ofc_path_hidden(OFC_PATH *path);
 
OFC_CORE_LIB OFC_VOID ofc_path_free_server(OFC_PATH *path);
 
OFC_CORE_LIB OFC_LPCTSTR ofc_path_server(OFC_PATH *path);
 
OFC_CORE_LIB OFC_INT ofc_path_port(OFC_PATH *path);
 
OFC_CORE_LIB OFC_VOID ofc_path_set_port(OFC_PATH *_path, OFC_INT port);
 
OFC_CORE_LIB OFC_VOID ofc_path_set_device(OFC_PATH *_path, OFC_LPCTSTR device);
 
OFC_CORE_LIB OFC_VOID
ofc_path_set_server(OFC_PATH *path, OFC_LPCTSTR server);
 
OFC_CORE_LIB OFC_VOID
ofc_path_set_share(OFC_PATH *_path, OFC_LPCTSTR share);
 
OFC_CORE_LIB OFC_VOID
ofc_path_set_filename(OFC_PATH *_path, OFC_LPCTSTR filename);
 
OFC_CORE_LIB OFC_BOOL
ofc_path_server_cmp(OFC_PATH *path, OFC_LPCTSTR server);
 
OFC_CORE_LIB OFC_BOOL
ofc_path_port_cmp(OFC_PATH *_path, OFC_UINT16 port);
 
OFC_CORE_LIB OFC_LPCTSTR ofc_path_share(OFC_PATH *path);
 
OFC_CORE_LIB OFC_BOOL
ofc_path_share_cmp(OFC_PATH *path, OFC_LPCTSTR share);
 
OFC_CORE_LIB OFC_LPCTSTR ofc_path_username(OFC_PATH *path);
 
OFC_CORE_LIB OFC_VOID ofc_path_set_username(OFC_PATH *_path,
                                            OFC_LPCTSTR username);
 
OFC_CORE_LIB OFC_BOOL
ofc_path_username_cmp(OFC_PATH *path, OFC_LPCTSTR username);
 
OFC_CORE_LIB OFC_LPCTSTR ofc_path_password(OFC_PATH *path);
 
OFC_CORE_LIB OFC_VOID ofc_path_set_password(OFC_PATH *_path,
                                            OFC_LPCTSTR password);
 
OFC_CORE_LIB OFC_BOOL
ofc_path_password_cmp(OFC_PATH *path, OFC_LPCTSTR password);
 
OFC_CORE_LIB OFC_LPCTSTR ofc_path_domain(OFC_PATH *path);
 
OFC_CORE_LIB OFC_VOID ofc_path_set_domain(OFC_PATH *_path,
                                          OFC_LPCTSTR domain);
OFC_CORE_LIB OFC_BOOL
ofc_path_domain_cmp(OFC_PATH *_path, OFC_LPCTSTR domain);
 
OFC_CORE_LIB OFC_LPCTSTR ofc_path_device(OFC_PATH *path);
 
OFC_CORE_LIB OFC_VOID ofc_path_free_device(OFC_PATH *path);
 
OFC_CORE_LIB OFC_VOID ofc_path_free_username(OFC_PATH *path);
 
OFC_CORE_LIB OFC_VOID ofc_path_free_password(OFC_PATH *path);
 
OFC_CORE_LIB OFC_VOID ofc_path_free_domain(OFC_PATH *path);
 
OFC_CORE_LIB OFC_VOID
ofc_path_promote_dirs(OFC_PATH *path, OFC_UINT num_dirs);
 
OFC_CORE_LIB OFC_VOID ofc_path_set_local(OFC_PATH *_path);
 
OFC_CORE_LIB OFC_VOID ofc_path_set_remote(OFC_PATH *_path);
 
OFC_CORE_LIB OFC_VOID ofc_path_set_relative(OFC_PATH *path);
 
OFC_CORE_LIB OFC_VOID ofc_path_set_absolute(OFC_PATH *path);
 
OFC_CORE_LIB OFC_BOOL ofc_path_absolute(OFC_PATH *path);
 
OFC_CORE_LIB OFC_FST_TYPE ofc_path_type(OFC_PATH *path);
 
OFC_CORE_LIB OFC_VOID
ofc_path_set_type(OFC_PATH *path, OFC_FST_TYPE fstype);
 
OFC_CORE_LIB OFC_LPCTSTR ofc_path_filename(OFC_PATH *path);
 
OFC_CORE_LIB OFC_VOID ofc_path_free_filename(OFC_PATH *path);
 
OFC_CORE_LIB OFC_INT ofc_path_num_dirs(OFC_PATH *path);
 
OFC_CORE_LIB OFC_LPCTSTR ofc_path_dir(OFC_PATH *path, OFC_UINT ix);
 
OFC_CORE_LIB OFC_VOID ofc_path_free_dirs(OFC_PATH *path);
 
OFC_CORE_LIB OFC_VOID ofc_path_insert_dir(OFC_PATH *path, OFC_UINT ix,
                                          OFC_CTCHAR *dir);
 
OFC_CORE_LIB OFC_VOID ofc_path_debug(OFC_PATH *path);
 
OFC_CORE_LIB OFC_VOID init_workgroups(OFC_VOID);
 
OFC_CORE_LIB OFC_VOID destroy_workgroups(OFC_VOID);
 
OFC_CORE_LIB OFC_VOID update_workgroup(OFC_LPCTSTR workgroup);
 
OFC_CORE_LIB OFC_VOID remove_workgroup(OFC_LPCTSTR workgroup);
 
OFC_CORE_LIB OFC_BOOL lookup_workgroup(OFC_LPCTSTR workgroup);
 
#if defined(__cplusplus)
}
#endif
 
#if defined(OFC_UNICODE_API)
#define ofc_path_add_map ofc_path_add_mapW
#define ofc_path_create ofc_path_createW
#define ofc_path_print ofc_path_printW
#define ofc_path_make_url ofc_path_make_urlW
#define ofc_path_map ofc_path_mapW
#define ofc_path_delete_map ofc_path_delete_mapW
#define ofc_path_map_device ofc_path_map_deviceW
#define ofc_path_update_credentials ofc_path_update_credentialsW
#define ofc_path_get_root ofc_path_get_rootW
#else
#define ofc_path_add_map ofc_path_add_mapA
#define ofc_path_create ofc_path_createA
#define ofc_path_print ofc_path_printA
#define ofc_path_make_url ofc_path_make_urlA
#define ofc_path_map ofc_path_mapA
#define ofc_path_delete_map ofc_path_delete_mapA
#define ofc_path_map_device ofc_path_map_deviceA
#define ofc_path_update_credentials ofc_path_update_credentialsA
#define ofc_path_get_root ofc_path_get_rootA
#endif
 
#endif