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