Differences between revisions 10 and 60 (spanning 50 versions)
Revision 10 as of 2008-04-25 14:15:58
Size: 4716
Editor: KaiJaeger
Comment:
Revision 60 as of 2014-01-10 11:51:39
Size: 1563
Editor: KaiJaeger
Comment: New version
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
= SevenZip =
{{{SevenZip}}} is part of the CategoryAplTree project.

<<TableOfContents>>

== Warning ==

Note that 7zip issues an error when you pass something like this with the flag to preserve the directory structure:

{{{
C:\My\folder1\file.txt
C:\My\folder2\file.txt
}}}

This is a clearly a bug. However, you can easily get around this by executing the command within `C:\My` and this list of files:
{{{
folder1\file.txt
folder2\file.txt
}}}

In other words: relative paths are fine, absolute ones are not.

Since version 1.1.0 the `SevenZip` class issues in hint if this error occurs and absolute path names are used.
Line 3: Line 27:
[[TableOfContents]] The class "SevenZip" relies on an installed version of the Open Source zipper [[http://www.7-zip.org/ | 7zip]].
Line 5: Line 29:
INI files are still useful to provide settings to an application. Vista is not going to change this. The class makes it very easy to zip as well as unzip stuff.
Line 7: Line 31:
The Windows API methods provided to read a particular value have an advantage: they follow a clearly defined search path, and following that path they take not only the INI file into account, they also check the Windows registry and the command line parameter. Furthermore, they deliver always up-to-date values. "SevenZip" suppports the following formats:
 * 7z
 * split
 * zip
 * gzip
 * bzip2
 * tar
Line 9: Line 39:
They have disadvantages as well: You can either specify an appropriate extension or set the "type" property in order to enforce a certain format.
Line 11: Line 41:
 * They are slow
 * They return everything as a string

If you are not interested in the Windows registry and command line parameters, and if nobody else is changing your INI files while your application is running, then the "!IniFile" class introduced in this article might attract your attention.

This class allows you to use a kind of APL-Syntax in your INI files. Values not enclosed in quotes will be converted to numbers, everything else gets a string.

== Details ==

=== Character Values ===

An entry like:

{{{HomeFolder='C:/Windows/Appl/'}}}

results in a string holding the path.

=== Numeric Values ===

An entry like:

{{{FormSize=300 400}}}

results in a two-element-vector "!FormSize" holding two integers.

=== References ===

Furthermore, an entry like:

{{{LogFolder='{"HomeFolder}Logsfiles/'}}}

is treated in a special way: the name between the curlies is taken as the name of an already defined value. It is then replaced by the value of that entry.

== Example ==

=== Creating an Instance ===

After creating an instance from the class:

{{{MyIni←⎕New #.IniClass (,⊂'C:/Appl/Example.ini')}}}

=== Accessing Data with the "Get" method ===

you can get all information you are interested in by calling the method "Get". Note that names are '''not''' case sensitive.

Given this file "Example.ini":
Line 58: Line 42:
[GENERAL]
MaxNoOfErrors=20
FormSize=800 1200
LogfileFlag=1
LogLevels=1 2 3 ; from 1 to 9

[DIR]
Home='C:/mainfolder/'
AppFolder='{Home}appls/'
DocsFolder='{Home}docs/'
LogFileFolder='{Home}Logs/'
      myZipper←⎕new #.SevenZip (,⊂'MyZipFile')
      ⎕←myZipper
[SevenZip@MyZipFile]
      myZipper.Add 'foo.txt'
      ⎕←myZipper.List 0
foo.txt
myZipper.Unzip 'c:\output\'
Line 71: Line 51:
You can get any level of information you are interested in: == Project Page ==
Line 73: Line 53:
 * get everything
 * get only a particular section
 * get a particular value in a particular section
For bug reports, future enhancements and a full version history see SevenZip/ProjectPage
Line 77: Line 55:
==== Examples with "Get" ==== == Version Information ==
||Original author: ||KaiJaeger ||
||Responsible: ||KaiJaeger ||
||Email: || kai@aplteam.com ||
Line 79: Line 60:
{{{
      MyIni.Get ⍬ ⍬
 GENERAL
          MAXNOOFERRORS 20
          FORMSIZE 800 1200
          LOGFILEFLAG 1
          LOGLEVELS 1 2 3
 DIR
          HOME C:/mainfolder/
          APPFOLDER C:/mainfolder/appls/
          DOCSFOLDER C:/mainfolder/docs/
          LOGFILEFOLDER C:/mainfolder/Logs/
      MyIni.Get'General' ⍬
MAXNOOFERRORS 20
FORMSIZE 800 1200
LOGFILEFLAG 1
LOGLEVELS 1 2 3
      MyIni.Get'General' 'FormSize'
800 1200
      ¯1 MyIni.Get'General' 'Unknown' ⍝ with default
¯1
      MyIni.Get'General' 'Unknown' ⍝ without default
Value Error: "Unknown"
myDoc.Get'General' 'Unknown'
}}}

=== Indexing ===

Since version 1.1, the class provides a default property. That means you can access values by indexing.

Examples (with the same INI file listed above):

{{{
      MyIni[⊂'GeneRAL:']
20 800 1200 1 1 2 3
            ⊃MyIni[⊂'GeneRAL:FormSize']
800 1200
}}}

=== Assigning ===

            ⊃MyIni[⊂'GeneRAL:FormSize']←12 23

=== The "Put" method ===

            (12 23) MyIni.Put 'GeneRAL:FormSize'

=== The "Save" method ===

You can also change a particular value but the changed value will persist only if you execute the "Save" method at some point:

{{{
      MyIni[⊂'GeneRAL:FormSize']←⊂'¯1 1000
      MyIni.Save
}}}

==== A Warning ====

However, an INI file is by definition not a kind of database and should '''not''' be used to save data by the application itself. The "Save" method '''might''' be useful to initialise an INI file.

=== Check Keys before indexing ===

Note that using indexing, there is no default. That means that specifying an unknown value leads to an error. There are two ways to escape this problem:

{{{
      MyIni.Exist 'General:Unknown'
0
      MyIni.Default← ¯1 ¯1
      MyIni[⊂'General:Unknown']
¯1 ¯1
      MyIni[⊂'General:Unknown']←200
      MyIni[⊂'General:Unknown']
200
}}}

||Original author:||KaiJaeger||
||Responsible:||KaiJaeger||
||Email:||kai@aplteam.com||
||Current state:||1.1||

Goto the IniFileDownloadPage

== Creating an INI file ==
<<Include(APLTreeDownloads)>>
Line 165: Line 63:
CategoryOpenSourceApl CategoryAplAplDyalog CategoryAplTree

SevenZip

SevenZip is part of the CategoryAplTree project.

Warning

Note that 7zip issues an error when you pass something like this with the flag to preserve the directory structure:

C:\My\folder1\file.txt
C:\My\folder2\file.txt

This is a clearly a bug. However, you can easily get around this by executing the command within C:\My and this list of files:

folder1\file.txt
folder2\file.txt

In other words: relative paths are fine, absolute ones are not.

Since version 1.1.0 the SevenZip class issues in hint if this error occurs and absolute path names are used.

Overview

The class "SevenZip" relies on an installed version of the Open Source zipper 7zip.

The class makes it very easy to zip as well as unzip stuff.

"SevenZip" suppports the following formats:

  • 7z
  • split
  • zip
  • gzip
  • bzip2
  • tar

You can either specify an appropriate extension or set the "type" property in order to enforce a certain format.

      myZipper←⎕new #.SevenZip (,⊂'MyZipFile')
      ⎕←myZipper
[SevenZip@MyZipFile]
      myZipper.Add 'foo.txt'
      ⎕←myZipper.List 0
foo.txt
myZipper.Unzip 'c:\output\'

Project Page

For bug reports, future enhancements and a full version history see SevenZip/ProjectPage

Version Information

Original author:

KaiJaeger

Responsible:

KaiJaeger

Email:

kai@aplteam.com


CategoryAplTree

SevenZip (last edited 2018-03-03 11:38:43 by KaiJaeger)