[lmi-commits] [5419] Establish proem for xml product files

[Greg Chicares]

Revision: 5419
          http://svn.sv.gnu.org/viewvc/?view=rev&root=lmi&revision=5419
Author:   chicares
Date:     2012-03-07 17:45:13 +0000 (Wed, 07 Mar 2012)
Log Message:
-----------
Establish proem for xml product files

Modified Paths:
--------------
    lmi/trunk/Makefile.am
    lmi/trunk/objects.make

Added Paths:
-----------
    lmi/trunk/my_proem.cpp
    lmi/trunk/my_proem.hpp

Modified: lmi/trunk/Makefile.am
===================================================================
--- lmi/trunk/Makefile.am       2012-03-07 10:25:11 UTC (rev 5418)
+++ lmi/trunk/Makefile.am       2012-03-07 17:45:13 UTC (rev 5419)
@@ -290,6 +290,7 @@
     miscellany.cpp \
     multiple_cell_document.cpp \
     mvc_model.cpp \
+    my_proem.cpp \
     name_value_pairs.cpp \
     null_stream.cpp \
     outlay.cpp \
@@ -438,6 +439,7 @@
     my_db.cpp \
     my_fund.cpp \
     my_prod.cpp \
+    my_proem.cpp \
     my_rnd.cpp \
     my_tier.cpp
 product_files_LDADD = \
@@ -639,6 +641,7 @@
   miscellany.cpp \
   multiple_cell_document.cpp \
   mvc_model.cpp \
+  my_proem.cpp \
   null_stream.cpp \
   path_utility.cpp \
   premium_tax.cpp \
@@ -756,6 +759,7 @@
 
 test_premium_tax_SOURCES = \
   $(common_test_objects) \
+  calendar_date.cpp \
   data_directory.cpp \
   database.cpp \
   datum_base.cpp \
@@ -769,6 +773,8 @@
   mc_enum_types.cpp \
   mc_enum_types_aux.cpp \
   miscellany.cpp \
+  my_proem.cpp \
+  null_stream.cpp \
   path_utility.cpp \
   premium_tax.cpp \
   premium_tax_test.cpp \
@@ -787,6 +793,7 @@
 
 test_product_file_SOURCES = \
   $(common_test_objects) \
+  calendar_date.cpp \
   data_directory.cpp \
   database.cpp \
   datum_base.cpp \
@@ -802,6 +809,8 @@
   mc_enum_types.cpp \
   mc_enum_types_aux.cpp \
   miscellany.cpp \
+  my_proem.cpp \
+  null_stream.cpp \
   path_utility.cpp \
   premium_tax.cpp \
   product_data.cpp \
@@ -1047,6 +1056,7 @@
     mvc_controller.tpp \
     mvc_model.hpp \
     mvc_view.hpp \
+    my_proem.hpp \
     name_value_pairs.hpp \
     ncnnnpnn.hpp \
     null_stream.hpp \

Added: lmi/trunk/my_proem.cpp
===================================================================
--- lmi/trunk/my_proem.cpp                              (rev 0)
+++ lmi/trunk/my_proem.cpp      2012-03-07 17:45:13 UTC (rev 5419)
@@ -0,0 +1,55 @@
+// Proem for xml product files.
+//
+// Copyright (C) 2012 Gregory W. Chicares.
+//
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License version 2 as
+// published by the Free Software Foundation.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the Free Software Foundation,
+// Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+//
+// http://savannah.nongnu.org/projects/lmi
+// email: <address@hidden>
+// snail: Chicares, 186 Belle Woods Drive, Glastonbury CT 06033, USA
+
+// $Id$
+
+#ifdef __BORLANDC__
+#   include "pchfile.hpp"
+#   pragma hdrstop
+#endif // __BORLANDC__
+
+#include "my_proem.hpp"
+
+#include "calendar_date.hpp"
+#include "value_cast.hpp"
+#include "xml_lmi.hpp"
+
+/// Write proemial information such as a license notice to a product file.
+///
+/// Copy this file to '../products/src' and edit the copy to specify
+/// a proprietary proem, such as a specific copyright notice.
+///
+/// Argument 'file_leaf_name', unused in this specimen implementation,
+/// permits the proem to vary by file name.
+
+void write_proem
+    (xml_lmi::xml_document& document
+    ,std::string const&     // file_leaf_name
+    )
+{
+    std::string const y(value_cast<std::string>(today().year()));
+    document.add_comment("Copyright (C) " + y + " Gregory W. Chicares.");
+    document.add_comment("http://savannah.nongnu.org/projects/lmi";);
+    // The apparently-needless '""' prevents 'test_coding_rules.cpp'
+    // from complaining that this file has more than one RCS Id.
+    document.add_comment("$""Id: $");
+}
+


Property changes on: lmi/trunk/my_proem.cpp
___________________________________________________________________
Added: svn:keywords
   + Id

Added: lmi/trunk/my_proem.hpp
===================================================================
--- lmi/trunk/my_proem.hpp                              (rev 0)
+++ lmi/trunk/my_proem.hpp      2012-03-07 17:45:13 UTC (rev 5419)
@@ -0,0 +1,39 @@
+// Proem for xml product files.
+//
+// Copyright (C) 2012 Gregory W. Chicares.
+//
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License version 2 as
+// published by the Free Software Foundation.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the Free Software Foundation,
+// Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+//
+// http://savannah.nongnu.org/projects/lmi
+// email: <address@hidden>
+// snail: Chicares, 186 Belle Woods Drive, Glastonbury CT 06033, USA
+
+// $Id$
+
+#ifndef my_proem_hpp
+#define my_proem_hpp
+
+#include "config.hpp"
+
+#include "xml_lmi_fwd.hpp"
+
+#include <string>
+
+void write_proem
+    (xml_lmi::xml_document& document
+    ,std::string const&     file_leaf_name
+    );
+
+#endif // my_proem_hpp
+


Property changes on: lmi/trunk/my_proem.hpp
___________________________________________________________________
Added: svn:keywords
   + Id

Modified: lmi/trunk/objects.make
===================================================================
--- lmi/trunk/objects.make      2012-03-07 10:25:11 UTC (rev 5418)
+++ lmi/trunk/objects.make      2012-03-07 17:45:13 UTC (rev 5419)
@@ -229,6 +229,7 @@
   miscellany.o \
   multiple_cell_document.o \
   mvc_model.o \
+  my_proem.o \
   name_value_pairs.o \
   null_stream.o \
   outlay.o \
@@ -411,6 +412,7 @@
   miscellany.o \
   mortality_rates_fetch.o \
   mvc_model.o \
+  my_proem.o \
   null_stream.o \
   outlay.o \
   path_utility.o \
@@ -695,6 +697,7 @@
   miscellany.o \
   multiple_cell_document.o \
   mvc_model.o \
+  my_proem.o \
   null_stream.o \
   path_utility.o \
   premium_tax.o \
@@ -802,6 +805,7 @@
   $(boost_filesystem_objects) \
   $(common_test_objects) \
   $(xmlwrapp_objects) \
+  calendar_date.o \
   data_directory.o \
   database.o \
   datum_base.o \
@@ -815,6 +819,8 @@
   mc_enum_types.o \
   mc_enum_types_aux.o \
   miscellany.o \
+  my_proem.o \
+  null_stream.o \
   path_utility.o \
   premium_tax.o \
   premium_tax_test.o \
@@ -831,6 +837,7 @@
   $(boost_filesystem_objects) \
   $(common_test_objects) \
   $(xmlwrapp_objects) \
+  calendar_date.o \
   data_directory.o \
   database.o \
   datum_base.o \
@@ -846,6 +853,8 @@
   mc_enum_types.o \
   mc_enum_types_aux.o \
   miscellany.o \
+  my_proem.o \
+  null_stream.o \
   path_utility.o \
   premium_tax.o \
   product_data.o \
@@ -1041,6 +1050,7 @@
   my_db.o \
   my_fund.o \
   my_prod.o \
+  my_proem.o \
   my_rnd.o \
   my_tier.o \
   liblmi$(SHREXT) \