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