Apple-2-Tools
/
nulib2
mirror of https://github.com/fadden/nulib2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
nulib2/nulib2/State.h

158 lines
6.0 KiB
C
Raw Normal View History

Imported sources.
2000-05-23 01:55:31 +00:00
/*
Distinguish Unicode and Mac OS Roman strings NufxLib has historically made no effort to distinguish between the character set used for filenames on the local disk, and for filenames stored within the archive. Now all Unicode filename strings use the UNICHAR type and have "UNI" in the name, and all Mac OS Roman strings have "MOR" in the name. (The naming convention makes it obvious when you're assigning the wrong thing; on Linux both formats are char*, so the compiler won't tell you if you get it wrong.) The distinction is necessary because filesystems generally support Unicode these days, but on Windows you need to use a separate set of wide-character file I/O functions. (On Linux it all works with "narrow" strings, and the UTF-8 encoding is interpreted by applications.) The character set used for NuFX archive filenames is MOR, matching what GS/OS + HFS supported, and we want to be able to convert back and forth between MOR and a Unicode representation. This change updates the various character types and string names, adds conversion functions, and updates NuLib2 for proper execution on Linux. It does not include the (probably extensive) changes required for Windows UTF-16 support. Instead, the conversion functions are no-ops, which should result in NuLib2 for Windows continuing to behave in the same slightly broken way. This adds "test-names", which exercises Unicode filenames a bit. It will not pass on Win32. Also, tweaked the Linux makefiles to have explicit dependencies, rather than empty space and an expectation that "makedepend" exists. Also, minor source code cleanups. While this probably doesn't affect binary compatibility -- it's mainly a matter of naming and string interpretation -- there's enough going on that it should be considered an API revision, so this updates the version to 3.0.0.
2014-12-24 19:14:32 +00:00
* NuLib2
Changed from GPL to BSD license.
2007-02-19 23:11:55 +00:00
* Copyright (C) 2000-2007 by Andy McFadden, All Rights Reserved.
Imported sources.
2000-05-23 01:55:31 +00:00
* This is free software; you can redistribute it and/or modify it under the
Changed from GPL to BSD license.
2007-02-19 23:11:55 +00:00
* terms of the BSD License, see the file COPYING.
Imported sources.
2000-05-23 01:55:31 +00:00
*/
Fix include guards Symbols starting with "__" are reserved for use by the compiler.
2014-12-23 00:06:55 +00:00
#ifndef NULIB2_STATE_H
#define NULIB2_STATE_H
Imported sources.
2000-05-23 01:55:31 +00:00
#include "MiscStuff.h"
#include "NufxLib.h"
/*
Distinguish Unicode and Mac OS Roman strings NufxLib has historically made no effort to distinguish between the character set used for filenames on the local disk, and for filenames stored within the archive. Now all Unicode filename strings use the UNICHAR type and have "UNI" in the name, and all Mac OS Roman strings have "MOR" in the name. (The naming convention makes it obvious when you're assigning the wrong thing; on Linux both formats are char*, so the compiler won't tell you if you get it wrong.) The distinction is necessary because filesystems generally support Unicode these days, but on Windows you need to use a separate set of wide-character file I/O functions. (On Linux it all works with "narrow" strings, and the UTF-8 encoding is interpreted by applications.) The character set used for NuFX archive filenames is MOR, matching what GS/OS + HFS supported, and we want to be able to convert back and forth between MOR and a Unicode representation. This change updates the various character types and string names, adds conversion functions, and updates NuLib2 for proper execution on Linux. It does not include the (probably extensive) changes required for Windows UTF-16 support. Instead, the conversion functions are no-ops, which should result in NuLib2 for Windows continuing to behave in the same slightly broken way. This adds "test-names", which exercises Unicode filenames a bit. It will not pass on Win32. Also, tweaked the Linux makefiles to have explicit dependencies, rather than empty space and an expectation that "makedepend" exists. Also, minor source code cleanups. While this probably doesn't affect binary compatibility -- it's mainly a matter of naming and string interpretation -- there's enough going on that it should be considered an API revision, so this updates the version to 3.0.0.
2014-12-24 19:14:32 +00:00
* Things you can tell NuLib2 to do.
Imported sources.
2000-05-23 01:55:31 +00:00
*
* (Some debug code in NState_DebugDump() is sensitive to the order here.)
*/
typedef enum Command {
Reformatted files to use spaces instead of hard tabs. No substantitve changes.
2002-09-21 00:59:25 +00:00
kCommandUnknown = 0,
kCommandAdd,
kCommandDelete,
kCommandExtract,
kCommandExtractToPipe,
kCommandListShort,
kCommandListVerbose,
kCommandListDebug,
Added Binary II support. It's not quite seamless, but it's a lot better than what the original NuLib offered. Wrote first cut at verbose "help" output.
2002-10-09 00:15:24 +00:00
kCommandTest,
kCommandHelp
Imported sources.
2000-05-23 01:55:31 +00:00
} Command;
/*
* Program-wide state.
*/
typedef struct NulibState {
Reformatted files to use spaces instead of hard tabs. No substantitve changes.
2002-09-21 00:59:25 +00:00
/* global goodness */
const char* programVersion;
Imported sources.
2000-05-23 01:55:31 +00:00
Reformatted files to use spaces instead of hard tabs. No substantitve changes.
2002-09-21 00:59:25 +00:00
/* system-specific values */
char systemPathSeparator;
Upped version number to v2.0.0. Fixed filename conversion issues. Specifically: - Correctly handle '%' when preservation is OFF. - Accept 4-character extensions in '-ee' without risk of buffer overflow. - Fixed broken assert when converting long %xx names. - Store "AUX" as "%00AUX" when preserving names under Win32 (vs. "_AUX"). - Always store files with ':' as path separator. - Recognize that some Win32 variants (Win2K and later at the least) will accept both '/' and '\' as pathname separators. - Correctly convert ".//foo" to "foo" instead of "/foo". Corrected definition of F_OK under Win32.
2003-02-08 22:35:31 +00:00
char altSystemPathSeparator;
Imported sources.
2000-05-23 01:55:31 +00:00
Reformatted files to use spaces instead of hard tabs. No substantitve changes.
2002-09-21 00:59:25 +00:00
/* pointer to archive we're working with */
NuArchive* pArchive;
Imported sources.
2000-05-23 01:55:31 +00:00
Reformatted files to use spaces instead of hard tabs. No substantitve changes.
2002-09-21 00:59:25 +00:00
/* misc state */
Boolean suppressOutput;
Boolean inputUnavailable;
NuRecordIdx renameFromIdx;
char* renameToStr;
NuDataSink* pPipeSink;
NuDataSink* pCommentSink;
long matchCount;
long totalLen;
long totalCompLen;
Imported sources.
2000-05-23 01:55:31 +00:00
Reformatted files to use spaces instead of hard tabs. No substantitve changes.
2002-09-21 00:59:25 +00:00
/* temp storage */
long tempPathnameAlloc;
char* tempPathnameBuf;
Imported sources.
2000-05-23 01:55:31 +00:00
Reformatted files to use spaces instead of hard tabs. No substantitve changes.
2002-09-21 00:59:25 +00:00
/* command-line options */
Command command;
Boolean modUpdate;
Boolean modFreshen;
Boolean modRecurse;
Boolean modJunkPaths;
Boolean modNoCompression;
Added optional support for zlib deflate compression via the "-z" flag. The auto-config checks for zlib, and enables the features if found. This isn't ideal, but it'll do. The "gory debug" output is now available with the "-g" command.
2002-10-01 01:05:13 +00:00
Boolean modCompressDeflate;
Added support for bzip2 compression. Use NuTestFeature to determine which compression methods are available.
2002-10-09 23:12:33 +00:00
Boolean modCompressBzip2;
Reformatted files to use spaces instead of hard tabs. No substantitve changes.
2002-09-21 00:59:25 +00:00
Boolean modComments;
Added Binary II support. It's not quite seamless, but it's a lot better than what the original NuLib offered. Wrote first cut at verbose "help" output.
2002-10-09 00:15:24 +00:00
Boolean modBinaryII;
Reformatted files to use spaces instead of hard tabs. No substantitve changes.
2002-09-21 00:59:25 +00:00
Boolean modConvertText;
Boolean modConvertAll;
Boolean modOverwriteExisting;
Boolean modAddAsDisk;
Boolean modPreserveType;
Boolean modPreserveTypeExtended;
Imported sources.
2000-05-23 01:55:31 +00:00
Reformatted files to use spaces instead of hard tabs. No substantitve changes.
2002-09-21 00:59:25 +00:00
const char* archiveFilename;
char* const* filespecPointer;
long filespecCount;
Imported sources.
2000-05-23 01:55:31 +00:00
} NulibState;
NuError NState_Init(NulibState** ppState);
NuError NState_ExtraInit(NulibState* pState);
void NState_Free(NulibState* pState);
#ifdef DEBUG_MSGS
void NState_DebugDump(const NulibState* pState);
#endif
char NState_GetSystemPathSeparator(const NulibState* pState);
Upped version number to v2.0.0. Fixed filename conversion issues. Specifically: - Correctly handle '%' when preservation is OFF. - Accept 4-character extensions in '-ee' without risk of buffer overflow. - Fixed broken assert when converting long %xx names. - Store "AUX" as "%00AUX" when preserving names under Win32 (vs. "_AUX"). - Always store files with ':' as path separator. - Recognize that some Win32 variants (Win2K and later at the least) will accept both '/' and '\' as pathname separators. - Correctly convert ".//foo" to "foo" instead of "/foo". Corrected definition of F_OK under Win32.
2003-02-08 22:35:31 +00:00
char NState_GetAltSystemPathSeparator(const NulibState* pState);
Imported sources.
2000-05-23 01:55:31 +00:00
const char* NState_GetProgramVersion(const NulibState* pState);
NuArchive* NState_GetNuArchive(const NulibState* pState);
void NState_SetNuArchive(NulibState* pState, NuArchive* pArchive);
Boolean NState_GetSuppressOutput(const NulibState* pState);
void NState_SetSuppressOutput(NulibState* pState, Boolean doSuppress);
Boolean NState_GetInputUnavailable(const NulibState* pState);
void NState_SetInputUnavailable(NulibState* pState, Boolean isUnavailable);
NuRecordIdx NState_GetRenameFromIdx(const NulibState* pState);
void NState_SetRenameFromIdx(NulibState* pState, NuRecordIdx recordIdx);
char* NState_GetRenameToStr(const NulibState* pState);
void NState_SetRenameToStr(NulibState* pState, char* str);
NuDataSink* NState_GetPipeSink(const NulibState* pState);
NuDataSink* NState_GetCommentSink(const NulibState* pState);
long NState_GetMatchCount(const NulibState* pState);
void NState_SetMatchCount(NulibState* pState, long count);
void NState_IncMatchCount(NulibState* pState);
void NState_AddToTotals(NulibState* pState, long len, long compLen);
void NState_GetTotals(NulibState* pState, long* pTotalLen, long* pTotalCompLen);
long NState_GetTempPathnameLen(NulibState* pState);
void NState_SetTempPathnameLen(NulibState* pState, long len);
char* NState_GetTempPathnameBuf(NulibState* pState);
Command NState_GetCommand(const NulibState* pState);
void NState_SetCommand(NulibState* pState, Command cmd);
const char* NState_GetArchiveFilename(const NulibState* pState);
void NState_SetArchiveFilename(NulibState* pState, const char* archiveFilename);
char* const* NState_GetFilespecPointer(const NulibState* pState);
void NState_SetFilespecPointer(NulibState* pState, char* const* filespec);
long NState_GetFilespecCount(const NulibState* pState);
void NState_SetFilespecCount(NulibState* pState, long filespecCount);
Boolean NState_GetModUpdate(const NulibState* pState);
void NState_SetModUpdate(NulibState* pState, Boolean val);
Boolean NState_GetModFreshen(const NulibState* pState);
void NState_SetModFreshen(NulibState* pState, Boolean val);
Boolean NState_GetModRecurse(const NulibState* pState);
void NState_SetModRecurse(NulibState* pState, Boolean val);
Boolean NState_GetModJunkPaths(const NulibState* pState);
void NState_SetModJunkPaths(NulibState* pState, Boolean val);
Boolean NState_GetModNoCompression(const NulibState* pState);
void NState_SetModNoCompression(NulibState* pState, Boolean val);
Added optional support for zlib deflate compression via the "-z" flag. The auto-config checks for zlib, and enables the features if found. This isn't ideal, but it'll do. The "gory debug" output is now available with the "-g" command.
2002-10-01 01:05:13 +00:00
Boolean NState_GetModCompressDeflate(const NulibState* pState);
void NState_SetModCompressDeflate(NulibState* pState, Boolean val);
Added support for bzip2 compression. Use NuTestFeature to determine which compression methods are available.
2002-10-09 23:12:33 +00:00
Boolean NState_GetModCompressBzip2(const NulibState* pState);
void NState_SetModCompressBzip2(NulibState* pState, Boolean val);
Imported sources.
2000-05-23 01:55:31 +00:00
Boolean NState_GetModComments(const NulibState* pState);
void NState_SetModComments(NulibState* pState, Boolean val);
Added Binary II support. It's not quite seamless, but it's a lot better than what the original NuLib offered. Wrote first cut at verbose "help" output.
2002-10-09 00:15:24 +00:00
Boolean NState_GetModBinaryII(const NulibState* pState);
void NState_SetModBinaryII(NulibState* pState, Boolean val);
Imported sources.
2000-05-23 01:55:31 +00:00
Boolean NState_GetModConvertText(const NulibState* pState);
void NState_SetModConvertText(NulibState* pState, Boolean val);
Boolean NState_GetModConvertAll(const NulibState* pState);
void NState_SetModConvertAll(NulibState* pState, Boolean val);
Boolean NState_GetModOverwriteExisting(const NulibState* pState);
void NState_SetModOverwriteExisting(NulibState* pState, Boolean val);
Boolean NState_GetModAddAsDisk(const NulibState* pState);
void NState_SetModAddAsDisk(NulibState* pState, Boolean val);
Boolean NState_GetModPreserveType(const NulibState* pState);
void NState_SetModPreserveType(NulibState* pState, Boolean val);
Boolean NState_GetModPreserveTypeExtended(const NulibState* pState);
void NState_SetModPreserveTypeExtended(NulibState* pState, Boolean val);
Fix include guards Symbols starting with "__" are reserved for use by the compiler.
2014-12-23 00:06:55 +00:00
#endif /*NULIB2_STATE_H*/