[sword-devel] task
Bobby Nations
sword-devel@crosswire.org
Sat, 08 Sep 2001 22:03:09 -0500
Troy,
I had a nagging suspicion that leaving that function out would come back to haunt me. It's easy
enough to put it back in, and I'll do that tomorrow (or Monday). One function that returns a
formatted block of memory coming right up.
I'm curious, though, about why you would want to make your internals available to other classes that
way. After all, if you're giving the EntriesBlock class the responsibility of manipulating the raw
buffer, shouldn't it be the only class that manipulates it? Once you return the pointer into the
buffer, all bets are off.
Maybe it would help if I had a better understanding of how you intend to use this class? I've been
unable to find any other cpp file that makes use of the EntriesBlock class, which leads me to
believe that it's still in the design stage to some extent. If I knew more about it's consumers,
then I would be able to do a better job with the rewrite.
What are your opinions about using the STL constructs? Do you need the functions that use char
pointers because I can easily add them back in again. I just did a one for one replacement of the
char* with string.
Also, please give some guidance about how to rearrange the entries in the block when one is deleted
from the middle. I took the long route of moving all entries to the right of the deletion back one
and removing the last entry, but an even quicker approach would be just to move the last entry into
the empty spot. That, however, would wreck any sorting of the entries that might have been done,
which is why I didn't do it that way.
Thanks,
Bobby
"Troy A. Griffitts" wrote:
> Bobby,
> Thanks for the attempt. Unfortunately, the purpose of the class is to
> modify a raw buffer that can be retrieved with the:
>
> const char *getRawData(long *size);
>
> method. You have changed the interface leaving this public method out.
>
> Your rewrite meets the purposes of the test program, but my purpose was
> really to obtain the raw buffer that it is EntriesBlock's job to
> manipulate.
>
> I do appreciate the attempt.
>
> -Troy.
>
> Bobby Nations wrote:
> >
> > Troy,
> >
> > I took a shot at it, but it may not be what you're expecting. See, I just
> > rewrote it more or less completely. Gone are the calloc's and memcopy's.
> > Instead, I've written it to use the STL vector container. I can do it the
> > other way as well, but this is much cleaner to look at.
> >
> > Is there a reason why you didn't use the STL in the first place?
> >
> > Also, I modified the test program slightly since the original never called
> > the removeEntry function.
> >
> > I'm now able to add and entry, print it out, and then delete it via the
> > testblocks program. Just curious, but it sure would be helpful for us
> > newbies if there were a set of unit tests (something like CppUnit would
> > work nicely).
> >
> > Anyway, I've attached the changed files for your perusal.
> >
> > Cheers,
> >
> > Bobby Nations
> >
> > "Troy A. Griffitts" wrote:
> >
> > > Ok, here's some things that I've been meaning to get around to that I
> > > think might be a good, isolated place for people to begin getting
> > > involved in.
> > >
> > > There is a new class I started and is almost complete, but still has a
> > > few bugs. It will be used in compression of lexicons and dictionaries,
> > > but that isn't necessary knowledge to complete the class.
> > >
> > > The class can be found at sword/src/modules/common/entriesblk.cpp
> > >
> > > The test program for this class is at sword/tests/testblocks.cpp
> > >
> > > It's been a while since I looked at the code. I just ran the test
> > > program. The remove option doesn't seem to work.
> > >
> > > Anyone interested in completing this class, review the code and is you
> > > STILL what to complete this class :), please speak up!
> > >
> > > Thanks,
> > > -Troy.
> >
> > ------------------------------------------------------------------------
> > #include <entriesblk.h>
> > #include <iostream.h>
> > #include <string>
> > #include <stdio.h>
> >
> > void addEntry(EntriesBlock *eb) {
> > string input;
> > string body;
> > char line[1024];
> > cout << "\nEnter new Entry's text. '.' on an empty line to finish:\n";
> > do {
> > cout << "> ";
> > gets(line);
> > input = line;
> > if (input.compare("."))
> > body.append(input);
> > }
> > while (input.compare("."));
> > cout << "Adding new entry. Index is: " << eb->addEntry(body.c_str()) << "\n\n";
> > }
> >
> > void printEntry(EntriesBlock *eb, int index) {
> > if (index < eb->getCount()) {
> > cout << "Contents of entry [" << index << "]:\n";
> > cout << eb->getEntry(index) << "\n";
> > }
> > else cout << "Invalid entry number\n\n";
> > }
> >
> > void removeEntry(EntriesBlock *eb, int index) {
> > if (index < eb->getCount()) {
> > cout << "Removing entry [" << index << "]\n";
> > eb->removeEntry( index );
> > }
> > else cout << "Invalid entry number\n\n";
> > }
> >
> > int main(int argc, char **argv) {
> >
> > EntriesBlock *eb = new EntriesBlock();
> > string input;
> > char line[1024];
> >
> > cout << "Initial entry count should be 0: " << eb->getCount() << "\n";
> >
> > do {
> > cout << "[" << eb->getCount() << "] > ";
> > gets(line);
> > input = line;
> > if (input.length() > 0) {
> > switch (input[0]) {
> > case 'a': addEntry(eb); break;
> > case 'p': printEntry(eb, atoi(input.c_str()+1)); break;
> > case 'r': removeEntry(eb, atoi(input.c_str()+1)); break;
> > case 'q': break;
> > case '?':
> > default:
> > cout << "\n a - add a new entry\n";
> > cout << " p <entry_index> - print entry\n";
> > cout << " r <entry_index> - remove entry\n";
> > cout << " q - quit\n\n";
> > break;
> > }
> > }
> > }
> > while (input.compare("q"));
> >
> > delete eb;
> >
> > return 0;
> > }
> >
> > ------------------------------------------------------------------------
> > #include <entriesblk.h>
> > #include <stdlib.h>
> > #include <string.h>
> >
> > //
> > // Constructors
> > //
> >
> > //
> > // Destructor
> > //
> >
> > //
> > // Accessors
> > //
> > int EntriesBlock::getCount() { return m_entries.size(); }
> > string EntriesBlock::getEntry( int index ) { return m_entries[ index ]; }
> >
> > //
> > // Mutators
> > //
> > int EntriesBlock::addEntry( string str )
> > {
> > m_entries.push_back( str );
> > return m_entries.size();
> > }
> >
> > void EntriesBlock::removeEntry( int index )
> > {
> > // Shift everything back over the entrie to be deleted
> > int last = m_entries.size() - 1;
> > for ( int i=index; i<last; i++ )
> > {
> > m_entries[ i ] = m_entries[ i+1 ];
> > }
> > // Remove the empty entry at the end
> > m_entries.pop_back();
> > }
> >
> > ------------------------------------------------------------------------
> > #ifndef ENTRIESBLK_H
> > #define ENTRIESBLK_H
> >
> > #include <vector>
> > #include <string>
> >
> > class EntriesBlock
> > {
> > public:
> > //
> > // Constructors & Destructor
> > //
> >
> > //
> > // Accessors
> > //
> > int getCount();
> > string getEntry( int index );
> >
> > //
> > // Mutators
> > //
> > int addEntry( string entry );
> > void removeEntry( int index );
> >
> > private:
> > //
> > // Member variables
> > //
> > vector< string > m_entries;
> > };
> >
> > #endif