- documentation fixes in builder.h
[barry.git] / Changelog
blob31cc08184737e2c9afcbd949f0bedf765f6d8156
1 Release: version 0.0.2 - 2005/??/??
2 ------------------------------------------------------------------------------
3 2006/03/29
4         - copyright dates updated for 2006
5 2006/01/05
6         - backed out update to latest libusb DEVEL tree, since it is buggy.
7                 Stick with libusb 2005/11/26
8 2005/12/30
9         - added clean target to convenience Makefile
10         - added Boost to list of dependencies in README
11         - fixed minor compile warnings in base64.cc
12         - fixed new USB discovery code, and changed endpoint usage to use
13                 it, instead of the READ_ENDPOINT and WRITE_ENDPOINT
14                 constants... constants are now removed
15                 common.h, controller.cc, probe.cc, probe.h, usbwrap.cc
16         - added ClearHalt() to Usb::Device (usbwrap.cc)
17         - updated usbwrap.h to match latest libusb CVS devel tree
18         - updated README to refer to 2005/12/30 libusb CVS devel tree
19         - added roadmap to Todo list
20 2005/12/29
21         - added convenience Makefile in root directory
22         - added Hacking document
23         - minor touchups to README
24         - added caution warning to README, since this release will support
25                 delete / overwrite / upload functionality
26         - minor compile order change in Makefile (speed reasons)
27         - added dynamic endpoint discovery to probe.cc
28         - changed claim_interface/set_configuration() function call order in
29                 probe.cc based on feedback on the libusb mailing list
30         - added USB discovery code to usbwrap.{h,cc}
31 2005/12/23
32         - fixed packing bug in new upload header struct
33         - renamed CommonField union from data to u to be consistent
34         - added return_code field to DBAccess struct, for error checking
35         - added response checking during upload: if response is non-zero
36                 throw exception in controller.cc
37         - added sorting operators to record parser classes... when writing
38                 contact data to the device, it may be important to write
39                 group link items last, since they reference other contacts...
40                 This needs to be tested, and if not required, removed.
41         - added GROUP_FLAG field code to Contact parser class
42         - fixed offset bug in Contact and Calendar Build() functions
43         - fixed name bug in Contact::Build(), now output only with data
44         - added appointment type flag support to Calendar record parser
45                 class, and "all day event" flag support
46 2005/12/22
47         - added autoconf to Todo list
48         - refactored the protocol structures so that record structs can
49                 be reused for upload and download
50         - with new protostructs, more header control is handled by
51                 controller.cc instead of record.cc parsers and builders
52         - parser code now accepts an offset, to govern start of record data
53         - changed Data sizes from int to size_t and removed casts
54         - removed unneeded Parser::GetHeaderSize() (new protostructs make
55                 this obsolete)
56         - added Calendar::Build() for calendar uploads
57 2005/12/10
58         - added s11n-boost.h serialization templates for boost::serialization
59         - added boost::serialization to build
60         - minor change in usbwrap.cc to display error codes in decimal
61         - added SizePacket special case code to Socket::Send()... this is
62                 required when uploaded packet size is a multiple of 0x40,
63                 a special 3 byte size packet is sent
64         - moved some record class variables to public: so they can be
65                 properly serialized
66         - fixed variable name but in RecordBuilder template
67         - added -f switch to btool, for saving and loading of record data
68         - added -s switch to btool, for uploading saved data back to handheld
69         - added Controller::SaveDatabase()
70 2005/12/08
71         - fixed potential casting / pointer bug in controller.cc
72         - added builder.h, to support uploading
73         - minor comment fixes in parser.h
74         - added preliminary Contact protocol record building support
75         - fixed field order bug in ContactRecord protocol struct
76         - Contact record.h class now saves unknown Group Link field,
77                 for later saving
78 2005/12/07
79         - added -fno-strict-aliasing to compiler flags so gcc-4.0.x won't
80                 optimize away protocol struct casts
81                 see: 
82                 http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25235
83                 http://mail-index.netbsd.org/tech-kern/2003/08/11/0001.html
84                 http://groups.google.ca/group/comp.lang.c++.moderated/ \
85                         browse_thread/thread/e7bf096832526f8e/5714701b \
86                         02a2a3cc?hl=en#5714701b02a2a3cc
87         - changed headers so that any low level protocol-specific sizes and
88                 structs are completely hidden in the library...
89                 this adds library-only header: protostructs.h
91 Release: version 0.0.1 - 2005/11/25
92 ------------------------------------------------------------------------------
93 2005/11/25
94         - added barry.h for documentation purposes and application usage
95         - updated README for release
96         - renamed SBError exception class to BError
97         - updated Doxyfile to version 1.4.5
98         - added more doxygen comments
99 2005/11/24
100         - added conversion routines (and tests) between time_t and min1900_t
101         - added -v option to btool to dynamically control protocol dumping
102         - removed duplicated database database table display in controller.cc
103         - minor spelling corrections
104         - added copyright to usbwrap.{h,cc} as per earlier meeting
105         - added support for Old protocol Calendar entries
106 2005/11/20
107         - added legal.txt, to save typing when adding new source files
108         - ignore test-base64 file (cvsignore)
109         - added contact-to-ldif generation, and updated supporting code
110         - added argument to btool to support contact-to-ldif operation
111         - added Contact::GetPostalAddress()
112         - added README documentation in preparation for future release
113 2005/11/19
114         - added parser.{h,cc} virtual wrapper to generalize LoadDatabase()
115         - added code to socket.cc's Packet() command to re-receive on
116                 reception of empty packets... this seems to be a signal
117                 from the device that it needs more time for long transfers
118                 Current limit: 10 blank packets before exception is thrown
119                 Observed maximum blank count: 1
120         - added MessageRecord and OldMessageRecord to protocol.h
121         - changed common record field structs to one CommonField struct
122         - increased default USB timeout to 10 seconds (some loaded devices
123                 seem to need more time...)
124         - reorganized record.{h,cc} to try to reduce the code duplication
125         - record.h classes now "know" the sizes of their corresponding
126                 protocol structs... this may cause trouble down the line
127                 with Python, if used(?)
128         - added Message class for Email records
129         - removed the "Get*" database functions and replaced with
130                 general LoadDatabase() call, which loads any database
131                 available, and parses it with a Parser object
132         - added GetDBID() for searching for database numbers via name
133         - added test code to retrieve and display all email
134         - cleaned up comments
135         - renamed blackberry.{h,cc} to controller.{h,cc}
136         - renamed bbtool.cc to btool.cc
137         - added Makefile.conf
138         - added copyright notices to source files
139         - added COPYING file with GPL
140         - put parser in Barry namespace, and added auto_ptr-like mode for
141                 store object pointers
142         - added doxygen docs
143         - added header comments to convo.awk script
144         - removed Test() function in Controller object, and made class
145                 better suited to its general API purpose
146         - changed OpenMode() so it loads command table and DBDB... it is now
147                 a public API function
148         - moved Controller test code to btool.cc and made tool more
149                 generically useful... can now download any DB by name on
150                 the command line
151         - added mode checks to Controller
152         - added -t and -d command line options to btool
153         - added base64 routines from John Walker / Fourmilab and Citadel/UX
154         - converted base64 routines into an API, instead of hardcoded
155                 file based
156 2005/11/18
157         - changed project name to Barry, including namespaces
158         - renamed sbcommon.* to common.*
159         - increased USB default timeout to 2 seconds
160         - fixed formatting bug in Data operator<< output
161         - cleaned up the protocol packet structs, getting rid of the
162                 confusing param/simple split... param is now the tableCmd
163                 from the Command Table
164         - moved protocol structs from record.h to protocol.h
165         - added support for older version of the USB protocol, which matches
166                 the Cassis spec more closely
167         - fixed the hardcoded offsets in blackberry.cc's protocol parsing
168         - fixed Socket::Close() so on error, socket flags are reset.
169                 This stops Close() from being called twice on exception
170                 destructors
171 2005/11/17
172         - added Doxyfile to the project
173         - tuned Makefile
174         - added mode selection support to Blackberry class (RIM Desktop,
175                 RIM Bypass, and RIM_JavaLoader)
176                 Mode selection governs which socket is used in subsequent
177                 data transfers.
178         - added Command Table parsing and protocol support
179                 Blackberry class, and CommandTable record class
180         - added Database database parsing and protocol support
181                 Blackberry class and DatabaseDatabase record class
182         - added Address book retrieval support - dumps data to stdout for now
183         - fixed bug in CopyOnWrite mode in Data class, where could allocate
184                 less buffer than data copied
185         - added "easy exception" debug output macro
186         - fixed minor spelling error in protocol.cc
187         - fixed ModeSelectCommand protocol structure - it is not a parameter
188                 command, but uses the unknown slots for socket and flag
189                 data
190         - removed hardcoded socket numbers from protocol.h
191         - fixed bug in socket.cc:Open() where packet size was not properly
192                 saved
193         - implemented socket::Close()
194         - fixed sequence number checks, so it is reset properly on socket 0
195         - added Socket::NextRecord() for multiple record data transfers
196         - fixed input handling bug in translate.cc
197 2005/11/11
198         - added .cvsignore files to project
199         - added README notes to document the source architecture
200         - added dbsetup data script, which shows how to get into database
201                 mode, using the RIM Desktop mode, and open a socket
202         - added blackberry.{h,cc} class
203         - added command line parameters to bbtool.cc
204                 -l = list only
205                 -p = specify pin of blackberry device
206         - added blackberry test code in bbtool.cc - debugging the initial
207                 opening protocol: sockets, modes, etc... see dbsetup for
208                 results
209         - added copy-on-write functionality to Data class, so it can be used
210                 with plain data buffers with little performance impact
211         - added eout() and ddout() debugging - to separate:
212                 - regular debug output
213                 - exception debug output (should probably be logged to
214                         syslog someday, and never turned off)
215                 - raw data dump output
216         - changed errno SBError exception handler to try to decode the error
217                 numbers into english (limited success)
218         - fixed probe and socket USB Bulk message handling, so they don't
219                 use PollCompletions(), but use IO::Wait() (libusb_io_wait())
220         - added common packet size checker in protocol.cc
221         - fixed unpacked protocol packet structs... using gcc's
222                 __attribute__ ((packed)) ... see protocol.h
223         - added ModeSelectCommand structure (protocol.h)
224         - finished Socket::Open() call  (Close() not yet implemented)
225         - moved Socket::Send/Receive() out of private, as they can be used
226                 for socket 0 operations.
227         - cleaned up pointer management with macros:
228                 MAKE_PACKET()
229                 COMMAND()
230                 IS_COMMAND()
231         - added IO::Wait() and IO::Cancel() to correspond with libusb API
232         - added datadumping in usbwrap for easy protocol capture
233         - added preliminary record.{h,cc} classes
234         - added Contact record parsing, and test code
235 2005/10/20
236         - syncberry tree started