Changeset 4790

Timestamp:

Nov 21, 2021, 11:30:24 AM (3 years ago)

Author:

Andreas Schnellbacher

Message:

• Cosmetic changes.

File:

• trunk/src/netlabs/macros/file.e (modified) (27 diffs)

trunk/src/netlabs/macros/file.e ¶

@@ -172 +172 @@
 
 ; ---------------------------------------------------------------------------
-; Handle special NEPMD dirs: don't overwrite files of the NETLABS, EPMBBS or
+; Handles special NEPMD dirs: don't overwrite files of the NETLABS, EPMBBS or
 ; NETLABS src tree
---defproc SaveProcessNetlabsFile( var Filename, var fNameChanged)
 defproc SaveProcessNetlabsFile( Filename)
    rc = 0
@@ -281 +280 @@
 
 ; ---------------------------------------------------------------------------
-; This can be executed after a file with Filename is created. Is has to be
-; on top.
+; This can be executed after a file with Filename is created. The file to
+; quit must be on top.
 ; This is used to keep virtual filenames unique.
 defc QuitSameFile
@@ -320 +319 @@
 
 ; ---------------------------------------------------------------------------
+; Saves current file.
+; If a filename is specified, the current file is saved to the specified
+; filename and the current file isn't changed. To achieve that, Name should
+; be executed before.
+; If, for a temp. file, no filename is specified, the Save-as dialog is
+; opened to enter a filename.
+; Instead of a filename a longname may be specified. The longname is then
+; converted to a filename and after save, the longname is added, if
+; different from filename.
+; If a <filename> equal to current file is specified, the check for an
+; existing file to overwrite is bypassed.
 ; Syntax:
 ;    Save                               save
@@ -326 +336 @@
 ;    Name <filename> followed by Save   save, change to new filename
 ;    call Save( <filename>, 1)          used by SaveAs
-; If <filename> is specified, the check for an existing file to overwrite is
-; bypassed.
 defc Save, s
    Filename = StripQuotesFileSpec( arg( 1))
@@ -782 +790 @@
 
 ; ---------------------------------------------------------------------------
-; Returns a unique filename on non-FAT file systems for a passed filename.
+; Returns a unique filename on OS/2 file systems for a passed filename.
 ; Syntax:
 ;    UniqueFilename = MakeUniqueFilename( [Filename])
@@ -869 +877 @@
 
 ; ---------------------------------------------------------------------------
-; Returns a name valid for OS/2 file systems, similar to how OS/2 would
-; convert it. It accepts a filename or a drive as arg( 2) to determine the
-; filesystem first. It defaults to the current filename.
+; Converts a longname to a filename. Returns a name valid for OS/2 file
+; systems, similar to how OS/2 would convert it. It accepts a filename or a
+; drive as arg( 2) to determine the filesystem first. It defaults to the
+; current filename.
 ; Syntax:
 ;    ShortName = MakeFilename( [Longname [, FileSpec]])
@@ -953 +962 @@
 
 ; ---------------------------------------------------------------------------
-; Enquote FileSpec if required.
+; Enquotes FileSpec if required.
 defproc EnquoteFileSpec( FileSpec)
    if (not (leftstr( FileSpec, 1) = '"' & rightstr( FileSpec, 1) = '"')) &
@@ -963 +972 @@
 
 ; ---------------------------------------------------------------------------
-; Remove double quotes from enquoted strings.
+; Removes double quotes from enquoted strings.
 defproc StripQuotesFileSpec( FileSpec)
    if leftstr( FileSpec, 1) = '"' & rightstr( FileSpec, 1) = '"' &
@@ -1008 +1017 @@
 ; ---------------------------------------------------------------------------
 ; Syntax: SaveAll
-; Save all files of the ring. Discard non-modified and temp files. Reset
-; .modify for temp files. Bring unnamed files to the top.
+; Saves all files of the ring. Discards non-modified and temp files. Resets
+; .modify for temp files. Brings unnamed files to the top.
 defc SaveAll
    do once = 1 to 1
@@ -1225 +1234 @@
 
 ; ---------------------------------------------------------------------------
+; Checks if a Longname exists in a Dir. If yes, the file dialog is opened to
+; enter another longname. Sets rc. Returns NewFilename. Loops until a
+; non-existant longname is entered or on Cancel.
+;    rc = -5   NewLongFilename = ''      Cancel or error
+;    rc =  0   NewLongFilename = ''      Yes pressed or not found, overwrite
+;    rc =  1   NewLongFilename = '...'   No pressed and NewLongFilename selected
+; LongFilename means here: Longname with a prepended path, similar to a
+; fully-qualified filename.
 defproc SaveAsCheckLongnameExist( Longname, Dir)
    NewLongFilename = ''
@@ -1291 +1308 @@
 
 ; ---------------------------------------------------------------------------
--- TODO: Add arg( 2) = fCheckLongname
 ; Checks if a file exists. If yes, the file dialog is opened to enter another
 ; filename. Sets rc. Returns NewFilename. Loops until a non-existant filename
@@ -1800 +1816 @@
 
 ; ---------------------------------------------------------------------------
-; Lock file only if modified, unlock if .modify = 0
+; Locks file only if modified, unlocks if .modify = 0
 ; Todo: disable this if it failed once and for slow drives.
 defmodify
@@ -1814 +1830 @@
       endif
    endif
-   --sayerror '.modify = '.modify', .lockhandle = '.lockhandle', .readonly = '.readonly
-
-; ---------------------------------------------------------------------------
-; Can be used to toggle the lock state
+   --dprintf( '.modify = '.modify', .lockhandle = '.lockhandle', .readonly = '.readonly)
+
+; ---------------------------------------------------------------------------
+; Can be used to toggle the lock state.
 defc lock_on_modify
    if wordpos( upcase( arg( 1)), '0 OFF') then
@@ -1911 +1927 @@
    if result then
       if result = 32 then
-         sayerror ACCESS_DENIED__MSG '-' MAYBE_LOCKED__MSG' rc = ERROR_SHARING_VIOLATION.'
+         'SayError 'ACCESS_DENIED__MSG '-' MAYBE_LOCKED__MSG' rc = ERROR_SHARING_VIOLATION.'
          return result
       elseif result = 206 then  -- 206 = ERROR_FILENAME_EXCED_RANGE
@@ -1946 +1962 @@
       getfileid fileid, file
       if fileid == '' then
-         sayerror '"'file'"' DOES_NOT_EXIST__MSG
+         'SayError "'file'"' DOES_NOT_EXIST__MSG
          return 1
       endif
@@ -1955 +1971 @@
 defproc Unlock( fileid)
    if fileid.lockhandle = 0 then
-      sayerror fileid.filename NOT_LOCKED__MSG
+      'SayError 'fileid.filename NOT_LOCKED__MSG
       return 1
    endif
    result = dynalink32( 'DOSCALLS',    -- Free the original handle
-                        '#257',                    -- dos32close
+                        '#257',                    -- Dos32Close
                         atol( fileid.lockhandle), 2)
    if result then
-      sayerror 'DOSCLOSE' ERROR_NUMBER__MSG result
+      'SayError DosClose 'ERROR_NUMBER__MSG result
    else
       fileid.lockhandle = 0
@@ -1978 +1994 @@
       'xcom e /c 'EnquoteFileSpec( Name)
       if rc <> -282 then  -- -282 = sayerror( "New file")
-         sayerror ERROR__MSG rc BAD_TMP_FILE__MSG sayerrortext( rc)
+         'SayError 'ERROR__MSG rc BAD_TMP_FILE__MSG sayerrortext( rc)
          leave
       endif
@@ -2228 +2244 @@
 
 ; ---------------------------------------------------------------------------
-; Determine .readonly field from file attribute, if enabled
+; Determines .readonly field from file attribute, if enabled.
 defc ReadonlyFromAttrib
    KeyPath = '\NEPMD\User\Readonly'
@@ -2291 +2307 @@
 
 ; ---------------------------------------------------------------------------
-; Change drive. Release previous directory first (change to root dir).
-; Accept drives and dirs as arg.
+; Changes drive. Releases previous directory first (changes to root dir).
+; Accepts drives and dirs as arg.
 defproc ChDrive
    NewDir = arg( 1)
@@ -2321 +2337 @@
 
 ; ---------------------------------------------------------------------------
-; Change drive and directory. Release previous directory first (change to
+; Changes drive and directory. Releases previous directory first (changes to
 ; root dir).
 ; This should be used e.g. to change the directory on every defselect.
@@ -2339 +2355 @@
 
 ; ---------------------------------------------------------------------------
-; Change drive and directory. Release previous directory first (change to
+; Changes drive and directory. Releases previous directory first (changes to
 ; root dir). This should be used e.g. to change the directory on every
 ; defselect. Compared to Directory2, the 'cd' command is used to display
@@ -2362 +2378 @@
 
 ; ---------------------------------------------------------------------------
-; Change drive and directory. If a filename was specified, the directory of
+; Changes drive and directory. If a filename was specified, the directory of
 ; that file is used instead.
 defc xcd
@@ -2386 +2402 @@
 
 ; ---------------------------------------------------------------------------
-; Change drive and directory. Release previous directory first (change to
-; root dir). Give a message.
+; Changes drive and directory. Releases previous directory first (changes to
+; root dir). Gives a message.
 defc CDDlg
    CurDir = directory()
@@ -2412 +2428 @@
 
 ; ---------------------------------------------------------------------------
-; Helper to set startup dir for WPS objects.
+; Helper to set startup dir for EPM program objects.
 defc StartupDirDlg
    KeyPath = '\NEPMD\User\ProgramObjects\StartupDir'
@@ -2447 +2463 @@
    Filename = Filename\0
    rc = dynalink32( 'DOSCALLS',          -- dynamic link library name
-                    '#259',              -- ordinal value for DOSDELETE
+                    '#259',              -- ordinal value for Dos32Delete
                     address( Filename))
    return
@@ -2696 +2712 @@
                        address( BytesReadL), 2)       -- Bytes read
       if rc then
-         sayerror 'DosRead' ERROR__MSG rc
+         'SayError DosRead' ERROR__MSG rc
          return
       endif
@@ -2840 +2856 @@
 
 ; ---------------------------------------------------------------------------
-; For compatibilty
+; For compatibilty.
 defproc Get_File_Date( Filename)
    return GetFileDateHex( Filename)