Changeset 1287

Timestamp:

Nov 21, 2008, 3:08:11 PM (16 years ago)

Author:

John Small

Message:

Ticket 297: 1) More robust, flexible and user-friendly editing of DEF file
option description lines; 2) Support for compiling a copyright string
and linking it into distributed EXE and DLL files; 3) Improved update of
copyright years on a year change, including the About box;

Location:

trunk

Files:

• ReleaseEdit.cmd (modified) (6 diffs)
• ReleaseTool.cmd (modified) (4 diffs)
• dll/copyright.c (added)
• dll/fm3res.rc (modified) (2 diffs)
• makefile_post.mk (modified) (2 diffs)
• option_descriptions.txt (added)

trunk/ReleaseEdit.cmd ¶

@@ -3 +3 @@
  *
  * ReleaseEdit: a program which will set the version number
- *      and the date and time of a FM/2 release
+ *    and the date and time of a FM/2 release
  *
  * Usage:
- *      ReleaseEdit <version> <filename>
- *
- *      where <version> is x.y.z
- *
- *      and <filename> is ONE of the files (i.e. no wildcards)
- *      which need a version number and/or date/time:
- *         *.def, file_id.diz, dll\version.h, warpin\fm2.wis
+ *    ReleaseEdit <version> <relative-filename>
+ *
+ *    where <version> is x.y.z
+ *
+ *    and <relative-filename> is ONE of the files (i.e. no wildcards)
+ *    which need a version number and/or date/time:
+ *       *.def, file_id.diz, dll\version.h, warpin\fm2.wis
  *
  * Change log:
- *      18 Nov 08 JBS Ticket 297: Various build improvements/corrections
- *      - Use SysTempFilename instead of hard-coded temp file name
- *       - Commented out support for changing version in FM2.WIS
+ *    18 Nov 08 JBS Ticket 297: Various build improvements/corrections
+ *       -  Use SysTempFilename instead of hard-coded temp file name
+ *       -  Removed support for changing version in FM2.WIS (not needed)
+ *    21 Nov 08 JBS Ticket 297: Various build improvements/corrections
+ *       -  Changed code for option description lines in DEF files.
+ *          Instead of reading the current lines, they are recontructed
+ *          scratch. The data for these lines is:
+ *          - provided as a parameter (version/revision)
+ *          - read from a repository file, option_descriptions.txt
+ *            - all fields read from have default values
+ *            - support for environment variables
+ *          - edits length of all fields in option description
+ *       - added support for changing copyright years in:
+ *          - dll\copyright.c
+ *          - dll\fm3res.rc
+ *          - dll\fm3res.dlg (About box)
+ *       - improved error handling: tmp file renamed back to deleted file
+ *       - improved "usage" routine
  *
 */
@@ -31 +46 @@
 */
 
+/*
+   sed_separator:
+     - used only for SED edits of DEF file descriptions
+     - MUST be a character not found in ANY DEF file description!
+     - MUST be a character acceptable to SED as a separator
+*/
+sed_separator = '&'
+
+/* Process parameters */
 parse arg ver file .
 if ver = '' | file = '' then
-   call Usage 0                 /* and exit */
+   call Usage           /* and exit */
 else if stream(file, 'c', 'query exists') = '' then
-   call Usage 2                 /* and exit */
+   call Usage           /* and exit */
+/* Set extension, if none set it to uppercase(file) */
+ext = substr(translate(file), lastpos('.', file) +1)
 parse var ver major '.' minor '.' CSDLevel
 if CSDlevel = '' then
    CSDlevel = 0
+
+/* Set fixed strings */
+globals = 'repository copyright_year_marker copyright_year_marker_len'
+repository = 'option_descriptions.txt'
 mkstr_makefile  = 'DLL\INTERNAL\MAKEFILE'
 warpin_makefile = 'WARPIN\MAKEFILE'
-warpin_db_ver = (major + 0) || '\\' || (minor + 0) || '\\' || (CSDlevel + 0)
-warpin_makefile_ver  = major || '-' || minor || '-' || CSDlevel
-ext = substr(translate(file), lastpos('.', file) +1)   /* if no extension, ext <-- uppercase(file) */
 parse value date('s') with year 5 month 7 day
+last_year = year - 1
+
+/* Prepare temporary file */
 call RxFuncAdd 'SysTempFilename', 'REXXUTIL', 'SysTempFilename'
 tmpfile = SysTempFilename('redittmp.???')
@@ -53 +83 @@
       exit 1
    end
-'del' file
+if wordpos(ext, 'C RC DLG') = 0 then
+   'del' file
+
+/* Process the request */
 select
    when ext = 'DEF' then
       do
-         'sed -r -e "/Copyright/s/(Copyright.*20[0-9][0-9], )[0-9]*/\1' || year || '/g" -e "/desc/s/(SLAInc:).*(#@##1## )[0-9/]+ [0-9:]+/\1' || ver || '\2' || month || '\/' || day || '\/' || year right(major, 2, '0') || ':' || right(minor, 2, '0') || ':' || right(CSDlevel, 2, '0') || '/" ' || tmpfile || ' >' file
+         copyright_year_marker = 'copyright-year'
+         copyright_year_marker_len = length(copyright_year_marker)
+
+         vendor         = GetFromRepository( 'vendor', 'The Netlabs FM/2 team', 31 )
+         revision       = ver
+         buildhost      = GetFromRepository( 'buildhost', 'GKYBuild', 11 )
+         asd_feature_id = GetFromRepository( 'asd_feature_id', '', 11 )
+         language_code  = GetFromRepository( 'language_code', 'EN', 4 )
+         country_code   = GetFromRepository( 'country_code', 'US', 4 )
+         build          = GetFromRepository( 'build', '0', 7 )
+         processor_type = GetFromRepository( 'processor_type', 'U', 1 )
+         fixpack_ver    = GetFromRepository( 'fixpack_ver', '', 11 )
+         description    = GetFromRepository( 'desc.' || left(file, pos('.', file) - 1), '', 79 )
+         call stream repository, 'c', 'close'
+
+         option_description = '@#' || vendor || ':' || revision || '#@##1## ' || ,
+                              month || '/' || day || '/' || year || ' ' || ,  /* or day month year? */
+                              right(major, 2, '0') || ':' || right(minor, 2, '0') || ':' || right(CSDlevel, 2, '0') || ,
+                              copies(' ', 6) || buildhost || ':' || asd_feature_id || ':' || ,
+                              language_code || ':' || country_code || ':' || build || ':' || ,
+                              processor_type || ':' || fixpack_ver || '@@' || description
+         do forever
+            p = pos(copyright_year_marker, option_description)
+            if p = 0 then
+               leave
+            else
+               if p = 1 then
+                  option_description = year || substr(option_description, p + copyright_year_marker_len)
+               else
+                  if p + copyright_year_marker_len >= length(option_description) then
+                     option_description = left(option_description, p - 1) || year
+                  else
+                     option_description = left(option_description, p - 1) || year || substr(option_description, p + copyright_year_marker_len)
+         end
+         option_description = "option description '" || option_description || "'"
+         'sed -r -e "/option description/s' || sed_separator || '.*' || sed_separator || option_description || sed_separator || '" ' || tmpfile || ' >' file
+      end
+   when wordpos(ext, 'C RC DLG') > 0 then
+      do
+         signal off error
+         'grep -E "Copyright.*' || last_year || '[^,]" ' || file || ' >nul && del ' || file || ' && sed -r -e "/Copyright.*' || last_year || '[^,]/s/' || last_year || '/' || year || '/" ' || tmpfile || ' >' file
+         signal on error
       end
    when ext = 'H' then
@@ -73 +147 @@
    when right(ext, length(warpin_makefile)) = warpin_makefile then
       do
+         warpin_db_ver = (major + 0) || '\\' || (minor + 0) || '\\' || (CSDlevel + 0)
+         warpin_makefile_ver  = major || '-' || minor || '-' || CSDlevel
          'sed -r -e "/FM2_VER=-/s/(FM2_VER=-)[-0-9]+/\1' || warpin_makefile_ver || '/" ' || tmpfile || ' >' file
       end
    otherwise
-      nop                       /* Or error message or usage info? */
+      nop         /* Or error message or usage info? */
 end
 '@if exist' tmpfile 'del' tmpfile
 return
 
+/* Subroutines */
+GetFromRepository: procedure expose (globals)
+   parse arg value_name, value_default, max_value_len
+   /* Replace this with code for each DEF file */
+   call SysFileSearch value_name || '=', repository, 'lines.'
+   if lines.0 = 0 then
+      if left(value_name, 5) = 'desc.' then
+         call MissingDescriptionInRepository value_name
+      else
+         value_value = value_default
+   else
+      do
+         n = lines.0
+         parse var lines.n . '=' value_value
+      end
+   value_value = strip(value_value)
+   if length(value_value) > 1 then
+      if left(value_value, 1) = '%' & right(value_value, 1) = '%' then
+         do
+            value_value = value(substr(value_value, 2, length(value_value) - 2),, 'OS2ENVIRONMENT')
+            if value_value = '' then
+               value_value = value_default
+         end
+   if pos(copyright_year_marker, value_value) > 0 then
+      value_len = length(value_value) - copyright_year_marker_len + 4
+   else
+      value_len = length(value_value)
+   if value_len > max_value_len then
+      do
+         say
+         say 'Error in length of data field!'
+         say '  Field name:' value_name
+         say '  Length    :' value_len
+         say '  Max. len. :' max_value_len
+         say '  Field     :' value_value
+         say '  Trunc''d  :' left(value_value, max_value_len)
+         say
+         say 'This should be corrected in the repository:' repository
+         say
+         '@pause'
+      end
+return value_value
+
 Usage:
-   parse arg plus
-        say;say;say
-        lastline = sigl - (14 + plus)
-        do i = 1 to lastline
-                say sourceline(i)
-        end
-exit
+   say;say;say
+   i = 1
+   do forever
+      srcline = sourceline(i)
+      if pos('CHANGE LOG', translate(srcline)) > 0 then
+         exit
+      say srcline
+      i = i + 1
+   end
 
 /*=== Error() Report ERROR, FAILURE etc. and exit ===*/
@@ -107 +228 @@
     trace '?A'
     say 'Exiting.'
+    'ren' tmpfile file
     call 'SYSSLEEP' 2
     exit 'CONDITION'('C')
@@ -119 +241 @@
    signal ErrorExit
 
-
+/*
+ * bldlevel string docs:
+    Format of BLDLEVEL string (Type III)
+
+@#<Vendor>:<Revision>#@##1## DD.MM.YY hh:mm:ss      <BuildHost>:<ASDFeatureID>:<LanguageCode>:<CountryCode>:<Build>:<Unknown>:<FixPackVer>@@<Description>
+
+where
+
+    * DD.MM.YY is the build date in day/month/year, preceded by 1 space
+    * hh:mm:ss is the build time in hour/minute/second, preceded by 1 space
+    * <BuildHost> is machine on which build compiled, preceded by 8 spaces
+    * <ASDFeatureID> is identifier of ASD feature
+    * <LanguageCode> is code of language of component
+    * <CountryCode> is country code of component
+    * <Build> is build number
+    * <Unknown> is not known information (must be empty)
+    * <FixPackVer> is FixPack version (if distibuted as part of).
+
+Note: If you leave build date and/or build time empty you still have to provide the same amount of spaces to replace build date/build time.
+
+
+*/
+
+

trunk/ReleaseTool.cmd ¶

@@ -146 +146 @@
       when action = 6 then
          do /* Ensure the edits build */
+            'set WARNALL=1'
             'wmake -a all'
          end
@@ -178 +179 @@
       when action = 10 then
          do /* Build for the release */
-            'set FORTIFY=& set DEBUG=& wmake -a all'
+            'set FORTIFY='
+            'set DEBUG='
+            'wmake -a all'
          end
       when action = 11 then
@@ -349 +352 @@
         version_filelist = version_filelist 'viewinfs.def vtree.def file_id.diz'
         version_filelist = version_filelist 'warpin\makefile dll\internal\makefile'
+        version_filelist = version_filelist 'dll\copyright.c dll\fm3res.rc dll\fm3res.dlg'
 return
 
@@ -376 +380 @@
       say '18. TRAC updates.'
       say '19. Upload to distribution points and announce release.'
-      say '20. Set next version.'
+      say '20. Set next version (no HISTORY or README update).'
       say
       call charout , 'Enter the number of your choice (''X'' to exit; ''0'' to open a command line): '

trunk/dll/fm3res.rc ¶

@@ -45 +45 @@
 #include "fm3dll2.h"
 #include "fm3dlg.h"
+
+#define IDS_COPYRIGHT 1
 
 ICON        MAIN_FRAME          ..\icons\FM3.ICO
@@ -2336 +2338 @@
 }
 
+STRINGTABLE
+  BEGIN
+    IDS_COPYRIGHT, "Copyright (c) 1993, 1998 M. Kimes, " \
+                     "Copyright (c) 2001, 2008 Steven Levine and Associates, Inc." \
+                     "All rights reserved";
+  END
+
+
 HELPTABLE ID_HELPTABLE
 {

trunk/makefile_post.mk ¶

@@ -16 +16 @@
 # Executable specific paramters go in .def
 
-$(BASE).exe: $(BASE).lrf $(BASE).obj $(BASE).res $(BASE).def .explicit
+$(BASE).exe: $(BASE).lrf $(BASE).obj $(BASE).res $(BASE).def dll\copyright.obj .explicit
   $(LINK) @$(BASE).lrf @$(BASE).def
   @echo.
@@ -27 +27 @@
    @%append $^@ name $(BASE)
    @%append $^@ file $(BASE).obj
+   @%append $^@ file dll\copyright.obj
 !ifdef %EXCEPTQ
     @%append $^@ file exceptq.lib