update ChangeLog

Jean-Pierre Roux
FIX : Write - All the Sequences and Sequence Item are now written
            as 'no length' stuff, and a Sequence Delimitor aor an Item Delimitor
is added a the end, when necessary.
            - A lot of brain-damaged images, that were read correctly are
      now written correctly
- length compatible BinEntry are now loaded correctly
(even for odd groups)
            - Note : only Explicit Value Representation was checked.
(question : is implicit VR really necessary for gdcm ?)

DOC: typo

   * DEVELOPPER: added a proposition of coding style.
   * src/gdcmDocEntry.h: removed every inline declaration (for test of
     coding style).  --- Frog

ENH: Testing is now able to compare to the baseline properly

'(' and ')' removed around the return

minor modif to avoid casts

 Bugfixes.  --- JPR (with frog)

 src/gdcmDocument.cxx: bug fix.

 gdcmDocEntry::PrintCommonPart() and ::WriteCommonPart() removed.
     Use the gdcmDocEntry::Print() and Write() instead.

remove tabs

remove 'tab' caracters

gdcmDocument.cxx
- Now we do recognize the JpegLossLess format (there was a misstyping in
code 'beautyfication' :-(
- Now we automaticaticaly load the Luts, if any

STYLE: Cleanup outside API, there is still too much offered to user

FIX: GDCM was not compiling with -W -Wall

Now Binary data are loaded, whenever it's possible (i.e : not too long)

Removal of now useless gdcmDocument::LoadVLEntry method

Well ...
gdcmBinEntry::Write doesn't need filtetype parameter
(only PrintCommonPart does)

ENH : method  gdcmValEntry::Write doesn't need the filetype parameter (onlu
PrintCommonPart does)

remove tabs

please compile before commit

ENH: stdify

remove tabs

remove tabs

Update ChangeLog

2004-06-22 Jean-Pierre Roux
   In order : to write Sequences, whatever their imbrication level,
         : to allow user to create his own Sequences
a lot of modif where necessary (adding, moving, or virtualising methods)

WARNING : save your own sources *before* cvs up !

- gdcmBinEntry
  ADD virtual void Write(FILE *fp, FileType filetype);

   - gdcmDocEntry
  ADD virtual void Write(FILE *fp, FileType filetype);
  ADD void gdcmDocEntry::WriteCommonPart(FILE *fp, FileType filetype);

- gdcmDocEntrySet
  ADD virtual void Write (FILE *fp, FileType filetype)=0;
  ADD virtual gdcmDocEntry *GetDocEntryByNumber(guint16 group,guint16 element) = 0;
     ADD gdcmDocEntry *GetDocEntryByName(std::string name);
     ADD virtual std::string GetEntryByNumber(guint16 group,guint16 element) = 0;
     ADD std::string GetEntryByName(TagName name);
     ADD gdcmDictEntry *NewVirtualDictEntry(guint16 group,
                                            guint16 element,
                                            std::string vr     = "unkn",
                                            std::string fourth = "unkn",
                                            std::string name   = "unkn");
  ADD gdcmValEntry *NewValEntryByNumber(guint16 group, guint16 element);
     ADD gdcmBinEntry *NewBinEntryByNumber(guint16 group, guint16 element);
     ADD gdcmDocEntry *NewDocEntryByNumber(guint16 group, guint16 element);
     ADD gdcmDocEntry *NewDocEntryByName  (std::string Name);
     ADD gdcmDictEntry *GetDictEntryByName   (std::string Name);
     ADD gdcmDictEntry *GetDictEntryByNumber(guint16, guint16);
  REM virtual gdcmDocEntry *NewDocEntryByNumber(guint16 group, guint16 element)=0;
     REM virtual gdcmDocEntry *NewDocEntryByName  (std::string Name)=0;

- gdcmDocument
     ADD virtual bool WriteF(FileType type); // New stuff, with recursive exploration
     ADD virtual std::string GetEntryByName    (TagName tagName);
     ADD virtual std::string GetEntryVRByName  (TagName tagName);
     REM virtual bool Write(FILE *, FileType);
     REM virtual void WriteEntryTagVRLength(gdcmDocEntry *tag,
                                        FILE *_fp, FileType type);
     REM virtual void WriteEntryValue(gdcmDocEntry *tag,FILE *_fp,FileType type);
     REM virtual bool WriteEntry(gdcmDocEntry *tag,FILE *_fp,FileType type);
     REM virtual bool WriteEntries(FILE *_fp,FileType type);
     REM virtual std::string GetEntryByName    (std::string tagName);
     REM virtual std::string GetEntryVRByName  (std::string tagName);
     REM gdcmDictEntry *GetDictEntryByName  (std::string Name);
     REM gdcmDictEntry *GetDictEntryByNumber(guint16, guint16);
     REM gdcmDictEntry *NewVirtualDictEntry(guint16 group,
                                            guint16 element,
                                            std::string vr     = "unkn",
                                            std::string fourth = "unkn",
                                            std::string name   = "unkn");
     REM gdcmDocEntry *NewDocEntryByNumber(guint16 group, guint16 element);
     REM gdcmDocEntry *NewDocEntryByName  (std::string Name);
     REM gdcmValEntry *NewValEntryByNumber(guint16 group, guint16 element);
     REM gdcmBinEntry *NewBinEntryByNumber(guint16 group, guint16 element);

- gdcmElementSet
  ADD virtual void Write(FILE *fp, FileType filetype);

   - gdcmSeqEntry
  ADD virtual void Write(FILE *fp,FileType filetype);

   - gdcmSQItem
     ADD virtual void Write(FILE *fp, FileType filetype);
     ADD virtual std::string GetEntryByNumber(guint16 group, guint16 element);
     REM std::string GetEntryByNumber(guint16 group, guint16 element);
     REM std::string GetEntryByName(TagName name);

   - gdcmValEntry
 ADD virtual void gdcmValEntry::Write(FILE *fp, FileType filetype);

ERR: Remove bad legacy mode

* src/gdcmBinEntry.cxx, gdcmValEntry.cxx: gdcmBinEntry::Print() now
      properly calls gdcmValEntry::Print() (that was weed out from
      code related to gdcmBinEntry).

* Test/TestWriteSimple.cxx: fix to gdcmHeader-gdcmHeaderHelper revamping.
      The default constructor invoked by the line
         gdcmHeader *f1 = new gdcmHeader( header );
      was gdcmHeader::gdcmHeader(bool) instead of the expected
      gdcmHeader::gdcmHeader(std::string const &, bool = false, bool, bool).
      Hence the parsing wasn't executed... See also below.
    * src/gdcmHeader.h: the declaration of gdcmHeader::gdcmHeader(bool)
      as explicit constructor didn't do the trick to fix the above problem.
      Could anyone explain why ?   --- Frog

ENH: const'ify gdcmFile thus remove double signature with const char*

ENH: Ok second chunk of patch, tests seems to go smoothly
1. Compile with CMAKE_CXX_FLAGS (need to turn advanced ON) = -W -Wall -Werror
2. Add two virtual to destructor, with a bit of luck these were the leaks reported by frog

ENH:First chunk of patch:
1. Get rid of gdcmHeaderHelper, the class was only gdcmHeader with nice default values, no big deal
2. Left a legacy mode where you can still use the class gdcmHeaderHelper
3. Some minor clean up, but all the tests are passing

* Erroneous leading white fix:
     - src/gdcmDict.cxx: getline(from,xxx) doesn't remove the leading
       white[s] (as opposed to from >> xxx, that removes it [them].
     - src/gdcmTS.cxx: ditto.
     - gdcmPython/testSuite.py: dirty related kludge removed.
    * src/*: remaining references to gdcmParser removed.
    * src/*[cxx|h]: added copy[way]left header.    --- Frog

* In order to fix memory leaks:
     - Test/TestWriteSimple.cxx: added cleaning of free store through
       some delete calls.
     - src/gdcmBinEntry.cxx: fix to avoid SegFault.
     - src/gdcmDicomDir.[cxx|h]: fixed initialisation in constructor
       gdcmDicomDir::gdcmDicomDir(bool) [either the constructor itself
       (through the call to ::AddDicomDirMeta()) or the destructor
       would crash when deleting uninitialized ::metaElems].
     - src/gdcmDictEntry.cxx: annotation of ununderstood memory leak.
     - src/gdcmDocument.cxx:
       -- ::~gdcmDocument() destructor now cleans up all dictionary entries
          from dynamic stores.
       -- ::ParseDES() misplaced deletion of temporary NewDocEntry
          was causing memory leaks.
     - src/gdcmSQItem.cxx:
       -- ::~gdcmSQItem() dummy code cleaned (learned that deletion is
          cleanly handled with polymophism: sorry but my milage is low).
       -- ::SetEntryByNumber(string, guint16, guint16) now cleanly allocates
          a gdcmValENtry, and makes no assumption on type (gdcmDocEntry,
          gdcmSeqEntry vs gdcmValEntry) of existing entry (when present).
          This avoids SegFaulting.
     - src/gdcmSQItem.h: coding style.
    * Conclusion:
     - Test/TestWriteSimple still severely sucks. The output image content
       (when $(GDCMDATA_HOME)/012345.002.050.dcm in input) is brain
       damaged when displayed with vtkgdcmViewer.
     - on memory leaks: TestWriteSimple leaks really less (see entry
       of 2004-06-18 in Changelog file for the call to valgrind).
     - on segfaults: ctest now passes all the tests but one (no more
       segfaults).

   * In order to fix writing of dicom files:
     - Test/TestWriteSimple.cxx: a simpler example of writing.
     - Test/CMakeLists.txt changed accordingly.
     - src/gdcmDocument.cxx:
       -- The destructor now recursilvely removes potential sequences.
       -- Bug fix in ::IsJPEG2000()
       -- ::ReplaceOrCreateByNumber(std::string, guint16, guint16)
          now handles promotion of gdcmDocEntry to gdcmValEntry in a cleaner
          manner.
       -- ::GetValEntryByNumber(guint16, guint16) now defined (as opposed
          to only declared) and build on top of
          ::GetDocEntryByNumber(guint16, guint16).
       -- ::SetEntryByNumber() now uses GetValEntryByNumber(group, element)
     - src/gdcmElementSet.[h|cxx]: added ::RemoveEntry(gdcmDocEntry *)
       for usage in destructor and treatement of promotion in
       ::ReplaceOrCreateByNumber().
     - src/gdcmSQItem.cxx: destructor should better handle his job.
      Test/TestWriteSimple now runs (or at least it DOES something).
    * We can now start hutting memory links. A good starting point is:
      valgrind -q --skin=memcheck --leak-check=yes --leak-resolution=high
      --num-callers=100 --show-reachable=yes gdcmTests TestWriteSimple
      $(GDCMDATA_HOME)/012345.002.050.dcm foo.dcm

   * Valgrind note: after Mathieu Malaterre teached me how to read
      the valgrind FAQ ;-] (see http://valgrind.kde.org/faq.html), I
      learned that:
          Using gcc, you can force the STL to use malloc and to free memory as
          soon as possible by globally disabling memory caching.
          With 3.2.2 and later, you should export the environment variable
          GLIBCPP_FORCE_NEW before running your program.
      By setting GLIBCPP_FORCE_NEW, STL related memory leak messages of gdcm
      simply vanish (it is still not clear to me, whether this means that STL
      std::string leaks or if valgrind believes it leaks...).
    * Fixing of SegFault of Test/makeDicomDir (as shown by ctest or by
      running bin/gdcmTests makeDicomDir):
      - src/gdcmDicomDir.cxx: dynamic casting used + clean up.
      - Test/makeDicomDir.cxx now properly traps empty lists and returns
        with 1.
      NOW, makeDicomDir cleanly fails (in ctest terminology) instead of
      SegFaulting (I drowned in DicomDir related code when trying to
      understand why the list is empty...).
    * src/gdcmDocument.h: first BSD license header try.
    * Doc/License.txt added.           --- Frog

* src/gdcmDocument.[h|cxx]:
      - Clean up of the Transfer related predicates. They are now all based
        on new method isGivenTransferSyntax, that (should) handle properly
        the padding problem.
      - general clean up, simplification, and coding style.
      - Specific clean up of Parse7FE0() (umproperly named actually).
    * gdcmPython/testSuite.py: an odd temporary kludge introduced.

update ChangeLog

Jean-Pierre Roux
   *  gdcmSeqEntry.cxx
   - fix the display of Sequence Delimitor (SQDepthLevel pb)
- fix the display of SQItem ordinal number
      - add the GetSQItemByOrdinalNumber method
- remove some useless never written private methods

Jean-Pierre Roux
gdcmBinEntry.cxx
   - adding a constructor taking a gdcmDocEntry as an input param
- ReplaceOrCreateByNumber now returns :
   a gdcmBinEntry * if a Binary (void *) value is passed as a param
a gdcmValEntry * if a string value is passed as a param
gdcmDocument.cxx
   - SetEntryByNumber now allows setting gdcmValEntry or gdcmBinEntry,
   according to the param type (no longer sets a gdcmDocEntry)
- GetValEntryByNumber, GetBinEntryByNumber added
   - NewValEntryByNumber and NewBinEntryByNumber added
gdcmFile.cxx
   - Pixel Data are now linked to the (7fe0,0010) elements, after reading
gdcmSQItem.h
   - GetSQItemNumber and SetSQItemNumber added, to provide
            a (relative) Item identier inside a given Sequence
            \warning : some pb remaining around this number
will be solved asap
   - AddEntry now takes the Item Number as a param
gdcmValEntry.cxx
   - adding a constructor taking a gdcmDocEntry as an input param

update ChangeLog

* Memory leak hunt with the following command:
      valgrind --leak-check=yes --leak-resolution=high --num-callers=40
               --show-reachable=yes gdcmTests PrintDocument
      It looks like many (all?) leaks are due to the STL (or a bad usage
      of the STL. The lines producing the leaks now have a comment with
      a "MEMORY LEAK" tag: you can retrieve them with
          grep "MEMORY LEAK" src/*
      Here are two typical examples which I can't help fixing:
      -----
          #include <string>
          int main() {
             std::string name;
             char * test = "babo";
             name = test;    //// <--- valgrind detects 960 bytes lost in
                             ////   call to std::string::operator=(char const*)
             name.clear();   //// Doesn't help !
             return 0;
          }
      -----
          #include <string>
          #include <iostream>
          int main() {
             std::string line;
             std::cout << "Type a bunch of characters followed by RETURN: ";
             getline(std::cin, line);   //// <--- valgrind dectects a loss
                                        //// of 1320 bytes in call to
                                        /// std::basic_istream<>& std::getline<>
             return 0;
          }
      -----

now gdcmFile::GetImageData loads pixels *and* updates 7fe0,0010 voidArea
(it helps !)

* src/gdcmHeader.[cxx|h]:
      - Predicates on the Transfer syntax (of the form Is[JPEF|RLE]*)
        and related, moved away to gdcmDocument.
      - Accessors (on the form [Get|Set]Entry*) set up to expose publicly
        the corresponding protected accessors of inherited class
        gdcmDocument, removed ! As a consequence gdcmFile had to be
        declared friend of class gdcmDocument (see below).
      - operator< moved to gdcmDocument (in fact it belongs to gdcmDicomDir).
      - Clean up of undefined or unused methods.
    * src/gdcmFile.[cxx|h]: added SetEntryByNumber (in order to take into
      account the changes to gdcmHeader.h).
    * src/gdcmDocument.h:
      - gdcmFile is now a friend class (in order to take into account the
        changes to gdcmHeader.h).
      - Predicates on the Transfer syntax (of the form Is[JPEF|RLE]*) added
        (see changes to gdcmHeader.h).
      - Accessors (reading on the form GetEntry*) are now public.
      - Clean up of undefined or unused methods.
    * src/gdcmDocument.cxx:
      - adaptation to changes to gdcmDocument.h
      - ::OpenFile now writes a verbose message when file cannot be opened.
      - some std::string properly set to VRKey
    * src/gdcmDicomDir.h: historical references to gdcmHeader changed to
      references to gdcmDocument.
    * Test/TestFindTags.cxx: changed accordingly to above changes.
    * gdcmPython/testSuite.py: adapted to renaming of acr files in
      cvs repository gdcmData.

* src/gdcmValEntry.h: member voidArea type changed from char* to void*.
    * src/gdcmBinEntry.h: member voidArea commented out, since it potentially
      conflicts with gdcmValEntry::voidArea.
    * src/gdcmValEntry.cxx: unmatching comment wiped out.
    * src/gdcmVR.[h|cxx]: added two predicates that partition the possible
      Value representation between StringRepresentable and BinaryRepresentable.
    * src/gdcmDocument.cxx:
      - method ParseDES: proper indentation restored and usage of
        gdcmVR::IsVROfGdcmStringRepresentable wired in.
      - method LoadDocEntry: the fingerprint left in the SetValue() of
        unloaded entries (length > MaxSizeLoadEntry) had curiously been
        removed. Reverting to previous code segment with the proper
        dynamic_cast< gdcmValEntry* >.
        Note: this was (partially) breaking the python test suite
              (gdcmPython/testSuite.py) that made usage of the above
              fingerprint to check presence of "Pixel Data".
    * src/gdcmDocEntry.h: coding style.
    * gdcmPython/__init__.py: environement variable GDCM_DATA_PATH is
      now taken into account.
    * gdcmPython/gdcm.i: adaptation to the new internal representation
      of gdcm (exit gdcmParser, hello gdcmDocument).
    * gdcmPython/testSuite.py: quick and dirty fix for loading vtkgdcmPython
      on posix.
    * gdcmPython/demo/PrintHeader.py: doesn't use the gdcmDocument::Print()
      anymore, but instead prints the loaded Python dictionary.
    * .... alas, the python testSuite is still broken.

sub-minor ... and so forth

 Sub-minor fixes on std inclusion... JPR + Frog

Still in a debugging status.
Don't use it (except Eric)

src/CMakeLists.txt :
     *  kernel (i.e. src/gdcm*) doesn't compile gdcmParser.cxx nor
        gdcmHeaderEntry.cxx anymore.
     * converted the file format from DOS return to un*x ones (it caused
       my lincvs graphical diff mode to display kinky results).   --- Frog

 Sub-minor std-related fixes... Jpr+Frog

Forget this one

moved from gdcmParser to gdcmDocument.
Please wait a little more before using

  Moved from gdcmHeader to gdcmDocument .

ENH: scandir was leaking like crazy, we shouldnt be using this function anyway

Last commit before the final(?) one, for the new version.
Please keep on wainting.

ENH: Add a new flag to vtkGdcmReader: AllowLookupTable, user can now select if he wants to use a lookuptable when possible, disable by default

ENH: copy gdcm.py to the right place thus we only need PYTHONPATH to point to binary dir now

BUG: Broke cmake183 by mistake, also enhance the init.py script

ENH: New support for cmake 2.0.1

Sooooon, it will be OK

PLEASE : keep on waiting for the final version !

* gdcmPython/gdcm.i : remove useless lines concerning the gdcmGlobal
      gdcmGlob
    * gdcmPython/setup.py : replace the use of cvar.gdcmGlob to gdcmGlobal
    * src/gdcmUtil.h : export methods
    -- BeNours

* Some more cleanup/enhancement in gdcmPython/CMakeLists.txt getting close
      to right behavior
    * Initial addition of automatic python testing
    * Initial addition of automatic image comparison

Bad hack for writting a blank file and shut up cmake

BUG: Small update but bug still subsist

Update INSTALL for cmake

ENH: pourFindTaggs -> TestFindTags

ENH: Change testChangeEntete -> TestChangeHeader

ENH: testWrite -> TestWrite

ENH: testDicomDir -> TestDicomDir

ENH: PrintBug -> TestBug

ENH: Change dcm2acr -> TestDcm2Acr

ENH: Change hashtest -> TestHash

BUG: Hopefully deals with cygwin/apple/vc++ library naming convention... sad that not everybody uses linux

ENH: Some more steps toward automatic Python+gdcm testing

ENH: gdcm.py is now copied to binary dir

Update TODO, clean Test/CMakeLists when cmake 2.x comes out

 * Bug fix under win32. Must be verified on linux !!! The shadow class file (.py)
       wasn't copied

general commit of (future) new classes.
PLEASE don't try to use right now

Swig should be found on win32 now, some cosmetic cleanup too

Mark as advanced: debug and Dart

Minor clean up

Initial start of support cmake 2.x

Remove my comments

ENH: Now Example is an option, ON by default

BUG: JP suggest me to do this change

* src/gdcmCommon.h, gdcmDicomDir.cxx, gdcmFile.cxx, gdcmHeaderHelper.h,
      gdcmParser.cxx, gdcmParser.h : bug fix for the Microsoft .Net compilation
     -- BeNours

forget this one

 * src/gdcmFile.cxx, gdcmHeader.cxx : bug fix for the msvc compilation
     * Test/ShowDicom.cxx : bug fix for msvc compilation
     * vtk/vtkgdcmViewer.cxx : bug fix for msvc compilation
     -- BeNours

about compile errors

The shows goes on

BUG: Write was clearly broken...can only blame myself

reintroduce testing

update ChangeLog

Taking into account the 'Dicom Sequences' leads up to introduce new concepts
(and new classes) :
a 'gdcmDocument' is composed of a set of Doc Entries, that are
  - elementary gdcmDocEntries (former gdcmHeaderEntries)
  - Sequence Doc Entries (gdcmSeqEntries)
    a Sequence is composed of Items.
    Each item is a set of Doc Entries (this is recursive)

The non uniqueness of the 'Dicom tag' is due to this recursivity
(never taken into account)
Our unability to add a new 'entry' in the header
    at the proper location (neither in the H-Table (map or multimap), nor in
    the Chained List is also due to this recursivity.

Don't try, right now, to use/modify/compile these new sources : nothing is
finished.
We just commit all the stuff, 'as is', in order not to loose it.

 * vtk/vtkGdcmReader.cxx : bug fix in the setting of file name
     -- BeNours

Cosmetic clean up

Better implementation of the black list

Add a black list of broken dicom images

 * vtk/vtkGdcmReader.cxx : bug fix when loading a list of files using the
       file prefix (SetFilePrefix)
     -- BeNours