Re: [pdf-devel] New functions for the Time Module

[Aleksander Morgado]

>
> That would be useful. Will make life easier when dealing with that
> whole high/low DWORD's thing.
Ok.

I also corrected the gnupdf-tsd.texi as there were some missing entries
in the menus generating warnings.

Also, I get an error generating the hackers guide:

texi2html --init-file=gnupdf-hg.init --css-include=manuals.css
gnupdf-hg.texi
*** Error: can't read init file gnupdf-hg.init

Is the gnupdf-hg.init file missing? Or should it be gnupdf-manual.init?

Here's the new patch for the API:


# Bazaar merge directive format 2 (Bazaar 0.90)
# revision_id: address@hidden
# target_branch: file:///home/aleksander/Development/libgnupdf_repo\
#   /trunk/
# testament_sha1: 70c2be31acec72ea78835b90c09a733edfd4d4b5
# timestamp: 2008-07-26 16:31:56 +0200
# base_revision_id: address@hidden
#
# Begin patch
=== modified file 'ChangeLog'
--- ChangeLog    2008-07-25 23:13:29 +0000
+++ ChangeLog    2008-07-26 14:31:46 +0000
@@ -1,3 +1,15 @@
+2008-07-26  Aleksander Morgado  <address@hidden>
+
+    * doc/gnupdf-tsd.texi (Types Module): Added missing menu entries for a
+    correct compilation.
+
+    * doc/gnupdf.texi (Platform-specific functions): New section including
+    the w32-specific `pdf_time_w32_set_from_filetime' function, to fastly
+    set the pdf_time_t to a given filetime-timescale epoch.
+    (Managing Time Values): New functions `pdf_time_set_from_i32' and
+    `pdf_time_set' in order to fastly set the pdf_time_t variable to a
given
+    unix-timescale epoch.
+
 2008-07-26  Jose E. Marchesi  <address@hidden>
 
     * doc/gnupdf-hg.texi (Naming Functions): New section.

=== modified file 'doc/gnupdf-tsd.texi'
--- doc/gnupdf-tsd.texi    2008-07-18 07:47:14 +0000
+++ doc/gnupdf-tsd.texi    2008-07-26 14:31:46 +0000
@@ -75,6 +75,7 @@
 * List Module::
 * Hash Module::
 * Error Module::
+* Types Module::
 @end menu
 
 @node Memory Allocation Module
@@ -4302,6 +4303,15 @@
 @menu
 * pdf_i64_add::
 * pdf_i64_abs::
+* pdf_i64_assign::
+* pdf_i64_assign_quick::
+* pdf_i64_cmp::
+* pdf_i64_copy::
+* pdf_i64_neg::
+* pdf_i64_new::
+* pdf_i64_div::
+* pdf_i64_mult::
+* pdf_i64_mod::
 @end menu
 
 @node pdf_i64_add

=== modified file 'doc/gnupdf.texi'
--- doc/gnupdf.texi    2008-07-25 17:25:07 +0000
+++ doc/gnupdf.texi    2008-07-26 14:31:46 +0000
@@ -4554,6 +4554,7 @@
 * Managing Time Span Values::
 * Time Span Comparison::
 * Calendar Spans Management::
+* Platform-specific functions::
 @end menu
 
 @node Time Related Data Types
@@ -4782,6 +4783,69 @@
 @end table
 @end deftypefun
 
+
address@hidden pdf_status_t pdf_time_set_from_u32 (pdf_time_t
@var{time_var}, pdf_u32_t @var{seconds})
+This function will initialize @var{time_var} to the given Unix time
(seconds since January 1st 1970) in UTC timescale.
+The time is represented as a 32-bit unsigned integer.
+
address@hidden @strong
address@hidden Parameters
address@hidden @var
address@hidden time_var
+The time variable to set. Should be a properly create time variable.
address@hidden seconds
+Seconds since January 1st 1970, 32-bit unsigned value.
address@hidden table
address@hidden Returns
+A status value:
address@hidden @code
address@hidden PDF_OK
+The operation succeeded.
address@hidden table
address@hidden Usage example
address@hidden
+pdf_time_t mytime;
+
+mytime = pdf_time_new ();
+
+pdf_time_set_from_i32(mytime, 1217009657);
+
address@hidden example
address@hidden table
address@hidden deftypefun
+
address@hidden pdf_status_t pdf_time_set_from_i64 (pdf_time_t
@var{time_var}, pdf_i64_t @var{seconds})
+This function will initialize @var{time_var} to the given Unix time
(seconds since January 1st 1970) in UTC timescale.
+The time is represented as a pdf_i64_t integer.
+
address@hidden @strong
address@hidden Parameters
address@hidden @var
address@hidden time_var
+The time variable to set. Should be a properly create time variable.
address@hidden seconds
+Seconds since January 1st 1970, pdf_i64_t variable.
address@hidden table
address@hidden Returns
+A status value:
address@hidden @code
address@hidden PDF_OK
+The operation succeeded.
address@hidden table
address@hidden Usage example
address@hidden
+pdf_time_t mytime;
+pdf_i64_t  epoch = pdf_i64_new(0,1217009657);
+mytime = pdf_time_new ();
+
+pdf_time_set_from_i64(mytime, epoch);
+
address@hidden example
address@hidden table
address@hidden deftypefun
+
+
+
 @deftypefun pdf_status_t pdf_time_add_cal_span (pdf_time_t
@var{time_var}, const struct pdf_time_cal_span_s address@hidden)
 Add the time span represented by the calendar span under the address in
@var{p_cal_span} to @var{time_var}.
 
@@ -5912,6 +5976,43 @@
 @end table
 @end deftypefun
 
address@hidden Platform-specific functions
address@hidden Platform-specific functions
+
address@hidden pdf_status_t pdf_time_w32_set_from_filetime (pdf_time_t
@var{time_var}, FILETIME address@hidden)
+This function will initialize @var{time_var} to the given Filetime
epoch in UTC timescale.
+
+This function is only available in Windows OS.
+
address@hidden @strong
address@hidden Parameters
address@hidden @var
address@hidden time_var
+The time variable to set. Should be a properly create time variable.
address@hidden p_filetime
+Pointer to a valid FILETIME structure, containing 100-nanosecond
intervals since 1 January 1601.
address@hidden table
address@hidden Returns
+A status value:
address@hidden @code
address@hidden PDF_OK
+The operation succeeded.
address@hidden table
address@hidden Usage example
address@hidden
+pdf_time_t mytime;
+FILETIME filetime;
+mytime = pdf_time_new ();
+
+/* do stuff to get the FILETIME */
+
+pdf_time_w32_set_from_filetime(mytime, &filetime);
+
address@hidden example
address@hidden table
address@hidden deftypefun
+
+
 
 @node The Filesystem Module
 @section The Filesystem Module

# Begin bundle
IyBCYXphYXIgcmV2aXNpb24gYnVuZGxlIHY0CiMKQlpoOTFBWSZTWSn2Z/wACm9fgGAwUff//38/
34D////6YBCXB9ADWfYs7mVS2BilLoZmOtBQ6q1hkE2KsYVthpoRxkyaGIxNGARgJhAGAmmjTI0A
wlJTNMhNpRm1Twp6jagAAGmgaAAABxkyaGIxNGARgJhAGAmmjTI0AwkRCBMRpMp6nqaaA1G1NRpk
9TRtQAP1J5Q9QCKUyCKn7Snin6qf6VPU/U/KYk8oyn6ptMiZGENGBPU0AVJICAJgkwp4mIRk1Nqm
nqeox6U2oaDQ9BACTKOfJ95fFZpii8Mu0KcVsVvsxGgtl2jG2W+DVBpHWU3lQhR3OtDxz9Pi3nDn
aYjSH7B6vhuWd5TMCN+1MdQVQTBVBoZBnH8k01wExckxUlfJcMtyvUC5bnsYSZ98U5xRa6PA+9ay
/Qs8KNjIEGbANnvYg01uo1GsxzVS603BN3O+3CK3Uri74tGBVcyWMjgnFsV2LoZ4fP6qB/tZeJuj
Z5XzIfe33xP+E4pUiqqlKCqpn5aZI6c1mrLIyLQzE593Kz2xw9R2Z4VqlUDM2pc2XE44zpKrWJTD
1m4gMB31sznSId7WLszGYbl2d1lBLzYx0dnc5wmSlaErzHjwBb0NJi8kHqqRv4+2ea3kAeo7RYEe
0Vq++V61JjSqVVSLebCD0DqoPs00X4d0K94hxtVUWYf647rDKprcMCcPVjp8vWGYSg38DyMy3Hrh
J6fUdaTfhr80tSoaBS5dI6RUo7Ky3g0T0xssMOlyOXQD9LhbMuFRZhgMpVYheB8mNjYMyXPXkrCP
wXlJNFsgxAHmTRKDL6BlqIzX4rECbuMcIwJX/kt1jlx1nZO5MYWS93s931v3S7/D327PzhgHgGIf
Yj0y2m++uzX5npiPc3u53U+HrXK1sLJN6dWogAtjGUBtBEggm3gBQRVVwJcrG1StdJoI851YbjZl
fMfrj38XEk/cfA1IQblYwNVootqt5Xbdr4cUpKTxjyR6LpIm92J3RMh3o9iYatZuRmWnQxSd5w+H
gxiYv5b34c85QGaHcw0mLbl0xXiiPlRXPlgIgCDyGBgi1+3UiIIiIiF2acu0melD4gju93m4vz6J
AsOSMUvZCUoVMLSFAvUh5AoAIZeQQhQ7fGh4EkC3kkl5qxHMyyc4kwZC8B7x3DoXGZWgyUIEcqi2
SRWVQVnSJMyowUnfDUJlN7Q5Naza3r3YyZNz5/joZsnv3OC96dLnVE5nXJHXylpaywqo1ilql8OO
qJ0v767OaEQbOEpeJlEI4lxyF9USuB4VpM8dBNZO5c89gS1bj9xzDMIKxOUbrZArkZCHcIjawlwu
odSVN1Ch5hYwcry8zCqFHfEZc8lKVCugKpoanI2Y8lzk3sWzWPny9FzlsWpdFN6iolLK5xOR3SHc
qRJrdjNNhrTbZpctnTBVl8TIalwultC4zhJFixkeQrvsgC5fSb3ncXC6FdMFsy46ODXBdJodnbrb
joZNS5xbomN9+yQbtE3f2UQo0RNjoeU4EgXBVCuPRqyodcsr1RLZF8ZZX3lb4mlk2RL9Jc0psZro
lZtqKxv4tLQ6+XL+iOBqdDWTQ0pydrgc4nxFcH1jQvp2Z9Q5dZBvEjfS0cnEO4LrTWYEFS2EqKZG
ElaiMQhM0oIqwWtqxvMPIyRFjjAOlRdEwnRvtE0z0mhi4MCqb1UlzU3up7CZIYsWDcyZO7u1ObJy
btDk+F0TUnLbk3Wtd1TeqW3JlTpZj0dHC+8w32SW4tjZE0JgcWuJTLnvkeJyib93JxXpberesrm6
uDKm9xb12Djw4Vg5XqTM1uTU2JrbYmxk6NbG+1ZYWrK/BGelLmpFW3MomdI0NFpG1oaQxZ7tPgwL
QILri/UcFTFJdCOBsbboQtSpBJ3iMDU4HE0PSI10LGp2oUhy7h2vpz4UfCK6b6zFbjA4suKKLJWU
ivggAHxLud9Ul0CpaUCVxxP6G1u120ai9U0qKbl65ipOgcFObJywO8sZi2sXkGBkaDLHbuDJC7OG
nHhfvpxi5x2O8vKwWGgSoYj9dAvJ0LLUK0DgYbqBQSdjl3Yt80LTmqLnbZ0c7NjF1Llxs1tJwZtz
JppY4rU0MREZYYm1OxUqy0kVl0LK9mwrBC2qZFtdjYwKFTJCqQXnDidmhwOPG0mhgZG41sVJr3sW
RZzNbgvXubWswLLODFxWam1cFpsR3hMNompSp5M0sgM++nq6ceHK3j1/YXA1xdD280olBfeTpBhx
jfVUqqaxur9OH3D2FHooT6lQsezoVpipoFWkqfItLOzsVKVKpUpcVLqi0VJ0eZ+JOw3FxiWF+ZYu
LzXNkRqiJU+Ioiy5QIYfc0BCYqhBZpNpoTGx/H5qi2+HyX5Iv/JGJDOiYVXijFGFBHyX8UaJo/Gt
RD+igPcwk4zQ2ZJMnudSUSQIKoRzOYPCH4kbetI3KUPbBAhgpWzSEoIQKmGCgcMJviVJinlSpQzT
NhVVglKmSUs+ZgSaaviP47ifl7t7U+Tz+n3vyfgz0chLl78X0aWZSmpeuU6om9xYqXvmuYt27+ux
1ofX6QuZN6xC2gePM7IYeIRpSYS1EOFAMXLYUOQ8Ap5CtBRYpaKWKWKtKWip/Fn7BQ/XUTXNR9UP
PILzQou9St7hPWdgZh2edvAxRZofsigazJ9zGHhPQ3yuMMvaecT8/TSXLe16vtej817BZTBgs9XR
7nhEwfOJg2vk3zY1KbnJ3Gwk+ZvPed2nribYnWj6IfzpH86kfCOz+UnF7bptcVnc4MXR3xOum93u
5m7X0a17W1tbaxZvhH0ZvGJg7Z7cnwRdvmDc2NLmZBBkAv5OLjuTIpSlnC3ua0rQIn20MmpXQVnd
POVclSit9WhTlU5ne2uSl7xxzfYvMHD8LonemLXE5NIeDyeLyYmx3ckTyZuxuaXBvcKZP3aS94MH
CpvZu2d6e/gnjptETziDQp76Js8eOjziaE1u+KapHRFGg8ocJQvBpgecahB8EvtllAKxWnnTg+CY
HKqUUFifGXRcl1S1F6i3GlrWiZu95e708O5Y6zpNa+evKlLR3GBidQvO8kyJDRaao5o6A1ALmMtY
5lF0vMhaCxI9zp0m14RxR/qmFGZB1eu3fnMqx1PaktxodpxXQvMvITotUVSaUM+hlcoukZKH8gda
HBXIlzIHdIBdIFAYiveCfWQhCFmsGpTAGmcLe/tzQkvGuNUol+jJSF03B+sxSHUfrKTemqbYhmnS
PXxdlcZJ2l13o8FO5c97vPUyXLmDNS9k9hi9Xua0icFzyb1ntYNzJRO9rbmTWh9v5D7xtHxSv1qf
2u8/sv7yofalYRNRch5AhCatYmDuDnGgaFRpgD71KWECFkxUXzoQ5CXB8g3hAsBCgdnXEFFFVu1c
ztR4/JFofcJ/+Wk9kj9JSpVSuuw4xPpLz5vAFSS3cJ5RP2HdC+SvWK7zT+zNEwYYjyOhN8VwPDX+
eiEqlUlUXbZNA4UVUiR4i/NFv+4P68tfHH1420aJPWp61P0+BqLjbmUkpBSfP/IXn4pDTr5B41DQ
sw06UJJfWtoEUi8dzEOxXQJFmKBxUXEyLlTv7UaFOn2BHYjNud4wMLQU84wIKNOVCJAlgfsFRCFA
A35YC0l5sToi+XfE2nC9OPH3S3FpJ5VJaLynzPsiWOHEykeETg0DRDgiNhKCX1H3ntLF8pMEweJo
O65wyO8mFof84+c9IXrTyrOFhCgHAQyCRQoGhdWgTaMbAukwRcVjJLZJjLWhfBaRJVyGTSZ08Qro
7JouSMQgD+4ZFe+ll6AocUwsaIhqpYRiEHOitYkIEgeHAcFIIXoPyRkuA82p2+7ROg1/J6B41A2J
3kRhA7Ak1zGcpMKFHMjpzaUCq3zIrnGpGzvFYNjf0Oq92GuNn40nqep6h3eDwkmMj0qVUT+1rWta
q9UtLF1lr2onlH+0OCRTeXo1eaW6Z3TRN5vFHkjVj0OxM/dhE8ew3Jgl61n3Kj91QksvgvnaXz43
C9reE89cYRJwOM4nsJAXBCMkyqAVIZrOehmj3DazuBhqzKY5SvkWFqGEqaEXDhRoRcDp7a6pSguP
hNVJ0AbCPKrJXrwtc0IV5BAbgGEUj1POB2qLSlIWOdvd4cAwlYWPDX+9NBDDFxKJrbl6N13JIYDc
H+D4xqHRjzR5i15qmhNKLsmyD7ZiVUtoMscchdI860UjAq0qWjs95RjkL5HVH5BrhshdjJGMwLp3
32mqQrgaJafKDSGo0lknPEOuKUAYBUPBOGIaIQ02zekKV1QoToukYOM1ShVJ96OpghUG9JUWsNWb
0XBsMWbTNMOKNAzhmkk9sTY80SEyh91Zcvh1nPgjIXW1todUAPNlvLUC3G2PcioYfVHadnXfplR4
TpLQtIWiYQ1k7Eh3RMzfUTV+8wHPVpi+JfF52/VJjJ1zZFydSModkT6xMLoh+iO/kiijItaOlxYz
iWh+93SL0cdIeaNRmjeYkdhMgoH/xdyRThQkCn2Z/wA=