Add missing symbol to DLL.

Clean up pdfioinfo example changes.
Rename pdfioFileGetModDate to pdfioFileGetModificationDate.
2025-04-11 03:06:47 +02:00 · 2025-02-13 19:27:04 -05:00 · 2025-02-13 19:25:44 -05:00 · 2025-02-13 18:56:43 -05:00 · 2025-02-13 18:47:28 -05:00 · 2025-02-12 15:54:47 +01:00
7 changed files with 174 additions and 70 deletions
--- a/CHANGES.md
+++ b/CHANGES.md
@ -4,6 +4,7 @@ Changes in PDFio
 v1.5.0 - YYYY-MM-DD
 -------------------

+- Added `pdfioFileGetModDate()` API (Issue #88)
 - Added support for using libpng to embed PNG images in PDF output (Issue #90)
 - Updated the pdf2txt example to support font encodings.

--- a/doc/pdfio.3
+++ b/doc/pdfio.3
@ -1,4 +1,4 @@
-.TH pdfio 3 "pdf read/write library" "2025-01-24" "pdf read/write library"
+.TH pdfio 3 "pdf read/write library" "2025-02-13" "pdf read/write library"
 .SH NAME
 pdfio \- pdf read/write library
 .SH Introduction
@ -3880,6 +3880,14 @@ const char * pdfioFileGetKeywords (
    pdfio_file_t *pdf
 );
 .fi
+.SS pdfioFileGetModificationDate
+Get the most recent modification date for a PDF file.
+.PP
+.nf
+time_t  pdfioFileGetModificationDate (
+    pdfio_file_t *pdf
+);
+.fi
 .SS pdfioFileGetName
 Get a PDF's filename.
 .PP
@ -4027,6 +4035,15 @@ void pdfioFileSetKeywords (
    const char *value
 );
 .fi
+.SS pdfioFileSetModificationDate
+Set the modification date for a PDF file.
+.PP
+.nf
+void pdfioFileSetModificationDate (
+    pdfio_file_t *pdf,
+    time_t value
+);
+.fi
 .SS pdfioFileSetPermissions
 Set the PDF permissions, encryption mode, and passwords.
 .PP
--- a/doc/pdfio.html
+++ b/doc/pdfio.html
@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <html lang="en-US">
 <head>
-<title>PDFio Programming Manual v1.4.1</title>
+<title>PDFio Programming Manual v1.5.0</title>
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
 <meta name="generator" content="codedoc v3.8">
 <meta name="author" content="Michael R Sweet">
 <meta name="language" content="en-US">
 <meta name="copyright" content="Copyright © 2021-2025 by Michael R Sweet">
-<meta name="version" content="1.4.1">
+<meta name="version" content="1.5.0">
 <style type="text/css"><!--
 body {
  background: white;
@ -251,7 +251,7 @@ span.string {
 <body>
 <div class="header">
 <p><img class="title" src="pdfio-512.png"></p>
-<h1 class="title">PDFio Programming Manual v1.4.1</h1>
+<h1 class="title">PDFio Programming Manual v1.5.0</h1>
 <p>Michael R Sweet</p>
 <p>Copyright © 2021-2025 by Michael R Sweet</p>
 </div>
@ -417,6 +417,7 @@ span.string {
 <li><a href="#pdfioFileGetCreator">pdfioFileGetCreator</a></li>
 <li><a href="#pdfioFileGetID">pdfioFileGetID</a></li>
 <li><a href="#pdfioFileGetKeywords">pdfioFileGetKeywords</a></li>
+<li><a href="#pdfioFileGetModificationDate">pdfioFileGetModificationDate</a></li>
 <li><a href="#pdfioFileGetName">pdfioFileGetName</a></li>
 <li><a href="#pdfioFileGetNumObjs">pdfioFileGetNumObjs</a></li>
 <li><a href="#pdfioFileGetNumPages">pdfioFileGetNumPages</a></li>
@ -432,6 +433,7 @@ span.string {
 <li><a href="#pdfioFileSetCreationDate">pdfioFileSetCreationDate</a></li>
 <li><a href="#pdfioFileSetCreator">pdfioFileSetCreator</a></li>
 <li><a href="#pdfioFileSetKeywords">pdfioFileSetKeywords</a></li>
+<li><a href="#pdfioFileSetModificationDate">pdfioFileSetModificationDate</a></li>
 <li><a href="#pdfioFileSetPermissions">pdfioFileSetPermissions</a></li>
 <li><a href="#pdfioFileSetSubject">pdfioFileSetSubject</a></li>
 <li><a href="#pdfioFileSetTitle">pdfioFileSetTitle</a></li>
@ -4223,6 +4225,17 @@ time_t pdfioFileGetCreationDate(<a href="#pdfio_file_t">pdfio_file_t</a> *pdf);<
 </tbody></table>
 <h4 class="returnvalue">Return Value</h4>
 <p class="description">Keywords string or <code>NULL</code> for none</p>
+<h3 class="function"><a id="pdfioFileGetModificationDate">pdfioFileGetModificationDate</a></h3>
+<p class="description">Get the most recent modification date for a PDF file.</p>
+<p class="code">
+time_t pdfioFileGetModificationDate(<a href="#pdfio_file_t">pdfio_file_t</a> *pdf);</p>
+<h4 class="parameters">Parameters</h4>
+<table class="list"><tbody>
+<tr><th>pdf</th>
+<td class="description">PDF file</td></tr>
+</tbody></table>
+<h4 class="returnvalue">Return Value</h4>
+<p class="description">Modification date or <code>0</code> for none</p>
 <h3 class="function"><a id="pdfioFileGetName">pdfioFileGetName</a></h3>
 <p class="description">Get a PDF's filename.</p>
 <p class="code">
@ -4418,6 +4431,17 @@ writes error messages to <code>stderr</code>.</p>
 <tr><th>value</th>
 <td class="description">Value</td></tr>
 </tbody></table>
+<h3 class="function"><a id="pdfioFileSetModificationDate">pdfioFileSetModificationDate</a></h3>
+<p class="description">Set the modification date for a PDF file.</p>
+<p class="code">
+<span class="reserved">void</span> pdfioFileSetModificationDate(<a href="#pdfio_file_t">pdfio_file_t</a> *pdf, time_t value);</p>
+<h4 class="parameters">Parameters</h4>
+<table class="list"><tbody>
+<tr><th>pdf</th>
+<td class="description">PDF file</td></tr>
+<tr><th>value</th>
+<td class="description">Value</td></tr>
+</tbody></table>
 <h3 class="function"><a id="pdfioFileSetPermissions">pdfioFileSetPermissions</a></h3>
 <p class="description">Set the PDF permissions, encryption mode, and passwords.</p>
 <p class="code">
--- a/examples/pdfioinfo.c
+++ b/examples/pdfioinfo.c
@ -13,6 +13,7 @@

 #include <pdfio.h>
 #include <time.h>
+#include <math.h>


 //
@ -25,11 +26,26 @@ main(int  argc,				// I - Number of command-line arguments
 {
  const char	*filename;		// PDF filename
  pdfio_file_t	*pdf;			// PDF file
-  const char	*author;		// Author name
-  time_t	creation_date;		// Creation date
-  struct tm	*creation_tm;		// Creation date/time information
-  char		creation_text[256];	// Creation date/time as a string
-  const char	*title;			// Title
+  pdfio_dict_t	*catalog;		// Catalog dictionary
+  const char	*author,		// Author name
+  		*creator,		// Creator name
+  		*producer,		// Producer name
+		*title;			// Title
+  time_t	creation_date,		// Creation date
+		modification_date;	// Modification date
+  struct tm	*creation_tm,		// Creation date/time information
+		*modification_tm;	// Modification date/time information
+  char		creation_text[256],	// Creation date/time as a string
+		modification_text[256],	// Modification date/time human fmt string
+		range_text[255];	// Page range text
+  size_t	num_pages;		// PDF number of pages
+  bool		has_acroform;		// Does the file have an AcroForm?
+  pdfio_obj_t	*page;			// Object
+  pdfio_dict_t	*page_dict;		// Object dictionary
+  size_t	cur,			// Current page index
+		prev;			// Previous page index
+  pdfio_rect_t	cur_box,		// Current MediaBox
+		prev_box;		// Previous MediaBox


  // Get the filename from the command-line...
@ -48,9 +64,14 @@ main(int  argc,				// I - Number of command-line arguments
  if (pdf == NULL)
    return (1);

-  // Get the title and author...
-  author = pdfioFileGetAuthor(pdf);
-  title  = pdfioFileGetTitle(pdf);
+  // Get the title, author, etc...
+  catalog      = pdfioFileGetCatalog(pdf);
+  author       = pdfioFileGetAuthor(pdf);
+  creator      = pdfioFileGetCreator(pdf);
+  has_acroform = pdfioDictGetObj(catalog, "AcroForm") != NULL ? true : false;
+  num_pages    = pdfioFileGetNumPages(pdf);
+  producer     = pdfioFileGetProducer(pdf);
+  title        = pdfioFileGetTitle(pdf);

  // Get the creation date and convert to a string...
  if ((creation_date = pdfioFileGetCreationDate(pdf)) > 0)
@ -63,12 +84,76 @@ main(int  argc,				// I - Number of command-line arguments
    snprintf(creation_text, sizeof(creation_text), "-- not set --");
  }

+  // Get the modification date and convert to a string...
+  if ((modification_date = pdfioFileGetModificationDate(pdf)) > 0)
+  {
+    modification_tm = localtime(&modification_date);
+    strftime(modification_text, sizeof(modification_text), "%c", modification_tm);
+  }
+  else
+  {
+    snprintf(modification_text, sizeof(modification_text), "-- not set --");
+  }
+
  // Print file information to stdout...
  printf("%s:\n", filename);
-  printf("         Title: %s\n", title ? title : "-- not set --");
-  printf("        Author: %s\n", author ? author : "-- not set --");
-  printf("    Created On: %s\n", creation_text);
-  printf("  Number Pages: %u\n", (unsigned)pdfioFileGetNumPages(pdf));
+  printf("           Title: %s\n", title ? title : "-- not set --");
+  printf("          Author: %s\n", author ? author : "-- not set --");
+  printf("         Creator: %s\n", creator ? creator : "-- not set --");
+  printf("        Producer: %s\n", producer ? producer : "-- not set --");
+  printf("      Created On: %s\n", creation_text);
+  printf("     Modified On: %s\n", modification_text);
+  printf("         Version: %s\n", pdfioFileGetVersion(pdf));
+  printf("        AcroForm: %s\n", has_acroform ? "Yes" : "No");
+  printf(" Number of Pages: %u\n", (unsigned)num_pages);
+
+  // Report the MediaBox for all of the pages
+  prev_box.x1 = prev_box.x2 = prev_box.y1 = prev_box.y2 = 0.0;
+
+  for (cur = 0, prev = 0; cur < num_pages; cur ++)
+  {
+    // Find the MediaBox for this page in the page tree...
+    for (page = pdfioFileGetPage(pdf, cur);
+         page != NULL;
+         page = pdfioDictGetObj(page_dict, "Parent"))
+    {
+      cur_box.x1 = cur_box.x2 = cur_box.y1 = cur_box.y2 = 0.0;
+      page_dict  = pdfioObjGetDict(page);
+
+      if (pdfioDictGetRect(page_dict, "MediaBox", &cur_box))
+        break;
+    }
+
+    // If this MediaBox is different from the previous one, show the range of
+    // pages that have that size...
+    if (cur == 0 ||
+        fabs(cur_box.x1 - prev_box.x1) > 0.01 ||
+        fabs(cur_box.y1 - prev_box.y1) > 0.01 ||
+        fabs(cur_box.x2 - prev_box.x2) > 0.01 ||
+        fabs(cur_box.y2 - prev_box.y2) > 0.01)
+    {
+      if (cur > prev)
+      {
+        snprintf(range_text, sizeof(range_text), "Pages %u-%u",
+                 (unsigned)(prev + 1), (unsigned)cur);
+        printf("%16s: [%g %g %g %g]\n", range_text,
+               prev_box.x1, prev_box.y1, prev_box.x2, prev_box.y2);
+      }
+
+      // Start a new series of pages with the new size...
+      prev     = cur;
+      prev_box = cur_box;
+    }
+  }
+
+  // Show the last range as needed...
+  if (cur > prev)
+  {
+    snprintf(range_text, sizeof(range_text), "Pages %u-%u",
+	     (unsigned)(prev + 1), (unsigned)cur);
+    printf("%16s: [%g %g %g %g]\n", range_text,
+	   prev_box.x1, prev_box.y1, prev_box.x2, prev_box.y2);
+  }

  // Close the PDF file...
  pdfioFileClose(pdf);
--- a/pdfio-file.c
+++ b/pdfio-file.c
@ -801,6 +801,18 @@ pdfioFileGetKeywords(pdfio_file_t *pdf)	// I - PDF file
 }


+//
+// 'pdfioFileGetModificationDate()' - Get the most recent modification date for a PDF file.
+//
+
+time_t					// O - Modification date or `0` for none
+pdfioFileGetModificationDate(
+    pdfio_file_t *pdf)			// I - PDF file
+{
+  return (pdf && pdf->info_obj ? pdfioDictGetDate(pdfioObjGetDict(pdf->info_obj), "ModDate") : 0);
+}
+
+
 //
 // 'pdfioFileGetName()' - Get a PDF's filename.
 //
@ -1126,6 +1138,20 @@ pdfioFileSetKeywords(
 }


+//
+// 'pdfioFileSetModificationDate()' - Set the modification date for a PDF file.
+//
+
+void
+pdfioFileSetModificationDate(
+    pdfio_file_t *pdf,			// I - PDF file
+    time_t       value)			// I - Value
+{
+  if (pdf && pdf->info_obj)
+    pdfioDictSetDate(pdf->info_obj->value.value.dict, "ModDate", value);
+}
+
+
 //
 // 'pdfioFileSetPermissions()' - Set the PDF permissions, encryption mode, and passwords.
 //
--- a/pdfio.h
+++ b/pdfio.h
@ -201,6 +201,7 @@ extern time_t		pdfioFileGetCreationDate(pdfio_file_t *pdf) _PDFIO_PUBLIC;
 extern const char	*pdfioFileGetCreator(pdfio_file_t *pdf) _PDFIO_PUBLIC;
 extern pdfio_array_t	*pdfioFileGetID(pdfio_file_t *pdf) _PDFIO_PUBLIC;
 extern const char	*pdfioFileGetKeywords(pdfio_file_t *pdf) _PDFIO_PUBLIC;
+extern time_t		pdfioFileGetModificationDate(pdfio_file_t *pdf) _PDFIO_PUBLIC;
 extern const char	*pdfioFileGetName(pdfio_file_t *pdf) _PDFIO_PUBLIC;
 extern size_t		pdfioFileGetNumObjs(pdfio_file_t *pdf) _PDFIO_PUBLIC;
 extern size_t		pdfioFileGetNumPages(pdfio_file_t *pdf) _PDFIO_PUBLIC;
@ -216,6 +217,7 @@ extern void		pdfioFileSetAuthor(pdfio_file_t *pdf, const char *value) _PDFIO_PUB
 extern void		pdfioFileSetCreationDate(pdfio_file_t *pdf, time_t value) _PDFIO_PUBLIC;
 extern void		pdfioFileSetCreator(pdfio_file_t *pdf, const char *value) _PDFIO_PUBLIC;
 extern void		pdfioFileSetKeywords(pdfio_file_t *pdf, const char *value) _PDFIO_PUBLIC;
+extern void		pdfioFileSetModificationDate(pdfio_file_t *pdf, time_t value) _PDFIO_PUBLIC;
 extern bool		pdfioFileSetPermissions(pdfio_file_t *pdf, pdfio_permission_t permissions, pdfio_encryption_t encryption, const char *owner_password, const char *user_password) _PDFIO_PUBLIC;
 extern void		pdfioFileSetSubject(pdfio_file_t *pdf, const char *value) _PDFIO_PUBLIC;
 extern void		pdfioFileSetTitle(pdfio_file_t *pdf, const char *value) _PDFIO_PUBLIC;
--- a/pdfio1.def
+++ b/pdfio1.def
@ -1,73 +1,20 @@
 LIBRARY pdfio1
-VERSION 1.4
+VERSION 1.5
 EXPORTS
-_pdfioArrayDebug
-_pdfioArrayDecrypt
-_pdfioArrayDelete
-_pdfioArrayGetValue
-_pdfioArrayRead
-_pdfioArrayWrite
 _pdfioCryptoAESDecrypt
 _pdfioCryptoAESEncrypt
 _pdfioCryptoAESInit
-_pdfioCryptoLock
 _pdfioCryptoMD5Append
 _pdfioCryptoMD5Finish
 _pdfioCryptoMD5Init
-_pdfioCryptoMakeRandom
-_pdfioCryptoMakeReader
-_pdfioCryptoMakeWriter
 _pdfioCryptoRC4Crypt
 _pdfioCryptoRC4Init
 _pdfioCryptoSHA256Append
 _pdfioCryptoSHA256Finish
 _pdfioCryptoSHA256Init
-_pdfioCryptoUnlock
-_pdfioDictDebug
-_pdfioDictDecrypt
-_pdfioDictDelete
-_pdfioDictGetValue
-_pdfioDictRead
-_pdfioDictSetValue
-_pdfioDictWrite
-_pdfioFileAddMappedObj
-_pdfioFileAddPage
-_pdfioFileConsume
-_pdfioFileCreateObj
-_pdfioFileDefaultError
-_pdfioFileError
-_pdfioFileFindMappedObj
-_pdfioFileFlush
-_pdfioFileGetChar
-_pdfioFileGets
-_pdfioFilePeek
-_pdfioFilePrintf
-_pdfioFilePuts
-_pdfioFileRead
-_pdfioFileSeek
-_pdfioFileTell
-_pdfioFileWrite
-_pdfioObjDelete
-_pdfioObjGetExtension
-_pdfioObjLoad
-_pdfioObjSetExtension
-_pdfioStreamCreate
-_pdfioStreamOpen
-_pdfioStringIsAllocated
-_pdfioTokenClear
-_pdfioTokenFlush
-_pdfioTokenGet
 _pdfioTokenInit
-_pdfioTokenPush
-_pdfioTokenRead
-_pdfioValueCopy
 _pdfioValueDebug
-_pdfioValueDecrypt
-_pdfioValueDelete
 _pdfioValueRead
-_pdfioValueWrite
-_pdfio_strtod
-_pdfio_vsnprintf
 pdfioArrayAppendArray
 pdfioArrayAppendBinary
 pdfioArrayAppendBoolean
@ -204,6 +151,7 @@ pdfioFileGetCreationDate
 pdfioFileGetCreator
 pdfioFileGetID
 pdfioFileGetKeywords
+pdfioFileGetModificationDate
 pdfioFileGetName
 pdfioFileGetNumObjs
 pdfioFileGetNumPages
@ -219,6 +167,7 @@ pdfioFileSetAuthor
 pdfioFileSetCreationDate
 pdfioFileSetCreator
 pdfioFileSetKeywords
+pdfioFileSetModificationDate
 pdfioFileSetPermissions
 pdfioFileSetSubject
 pdfioFileSetTitle
Author	SHA1	Message	Date
Michael R Sweet	c26b200a83	Add missing symbol to DLL.	2025-02-13 19:27:04 -05:00
Michael R Sweet	eff02198ab	Clean up pdfioinfo example changes.	2025-02-13 19:25:44 -05:00
Michael R Sweet	5f98c7838c	Rename pdfioFileGetModDate to pdfioFileGetModificationDate. Add pdfioFileSetModificationDate API. Update DLL exports file. Update docos and changelog.	2025-02-13 18:56:43 -05:00
Michael R Sweet	4f880bc0c1	Merge pull request #88 from tlaronde/info Extend by adding pdfioGetModDate and extend the pdfioinfo example	2025-02-13 18:47:28 -05:00
Thierry LARONDE	d032483ed4	Merge branch 'michaelrsweet:master' into info	2025-02-12 15:54:47 +01:00
Thierry LARONDE	8b2b013b36	Extend by adding pdfioGetModDate and extend the pdfioinfo example When exploring a PDF, it may be convenient to have the typical informations delivered by some "Document Properties"---and some more about the MediaBox(es). So just add the function to get the ModDate and extend the pdfioinfo example as an example of what the library do have and pdfioinfo as a debugging tool also. Signed-off-by: Thierry LARONDE <tlaronde@kergis.com>	2025-01-18 11:25:36 +01:00