Refactored the timelog code into its own file.

This commit is contained in:
John Wiegley 2009-01-29 18:22:28 -04:00
parent 9aaab88c61
commit 119b5dc197
3 changed files with 232 additions and 0 deletions

View file

@ -65,6 +65,7 @@ libledger_data_la_SOURCES = \
src/entry.cc \
src/account.cc \
src/journal.cc \
src/timelog.cc \
src/iterators.cc \
src/compare.cc
@ -137,6 +138,7 @@ pkginclude_HEADERS = \
src/entry.h \
src/account.h \
src/journal.h \
src/timelog.h \
src/iterators.h \
src/compare.h \
\

145
src/timelog.cc Normal file
View file

@ -0,0 +1,145 @@
/*
* Copyright (c) 2003-2009, John Wiegley. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* - Neither the name of New Artisans LLC nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
namespace ledger {
namespace {
void clock_out_from_timelog(std::list<time_entry_t>& time_entries,
const datetime_t& when,
account_t * account,
const char * desc,
journal_t& journal)
{
time_entry_t event;
if (time_entries.size() == 1) {
event = time_entries.back();
time_entries.clear();
}
else if (time_entries.empty()) {
throw parse_error("Timelog check-out event without a check-in");
}
else if (! account) {
throw parse_error
("When multiple check-ins are active, checking out requires an account");
}
else {
bool found = false;
for (std::list<time_entry_t>::iterator i = time_entries.begin();
i != time_entries.end();
i++)
if (account == (*i).account) {
event = *i;
found = true;
time_entries.erase(i);
break;
}
if (! found)
throw parse_error
("Timelog check-out event does not match any current check-ins");
}
if (desc && event.desc.empty()) {
event.desc = desc;
desc = NULL;
}
std::auto_ptr<entry_t> curr(new entry_t);
curr->_date = when.date();
curr->code = desc ? desc : "";
curr->payee = event.desc;
if (when < event.checkin)
throw parse_error
("Timelog check-out date less than corresponding check-in");
char buf[32];
std::sprintf(buf, "%lds", long((when - event.checkin).seconds()));
amount_t amt;
amt.parse(buf);
assert(amt.valid());
xact_t * xact = new xact_t(event.account, amt, XACT_VIRTUAL);
xact->set_state(item_t::CLEARED);
curr->add_xact(xact);
if (! journal.add_entry(curr.get()))
throw parse_error("Failed to record 'out' timelog entry");
else
curr.release();
}
} // unnamed namespace
time_log_t::~time_log_t()
{
TRACE_DTOR(time_log_t);
if (! time_entries.empty()) {
std::list<account_t *> accounts;
foreach (time_entry_t& time_entry, time_entries)
accounts.push_back(time_entry.account);
foreach (account_t * account, accounts)
clock_out_from_timelog(time_entries, current_time, account, NULL,
journal);
assert(time_entries.empty());
}
}
void time_log_t::clock_in(const datetime_t& checkin,
account_t * account = NULL,
const string& desc = "")
{
time_entry_t event(checkin, account, desc);
if (! time_entries.empty())
foreach (time_entry_t& time_entry, time_entries)
if (event.account == time_entry.account)
throw parse_error("Cannot double check-in to the same account");
time_entries.push_back(event);
}
void time_log_t::clock_out(const datetime_t& checkin,
account_t * account = NULL,
const string& desc = "")
{
if (time_entries.empty())
throw std::logic_error("Timelog check-out event without a check-in");
clock_out_from_timelog(time_entries, checkin, account, desc, journal);
}
} // namespace ledger

85
src/timelog.h Normal file
View file

@ -0,0 +1,85 @@
/*
* Copyright (c) 2003-2009, John Wiegley. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* - Neither the name of New Artisans LLC nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _TIMELOG_H
#define _TIMELOG_H
namespace ledger {
class time_entry_t
{
public:
datetime_t checkin;
account_t * account;
string desc;
time_entry_t() : account(NULL) {
TRACE_CTOR(time_entry_t, "");
}
time_entry_t(const datetime_t& _checkin,
account_t * _account = NULL,
const string& _desc = "")
: checkin(_checkin), account(_account), desc(_desc) {
TRACE_CTOR(time_entry_t, "const datetime_t&, account_t *, const string&");
}
time_entry_t(const time_entry_t& entry)
: checkin(entry.checkin), account(entry.account),
desc(entry.desc) {
TRACE_CTOR(time_entry_t, "copy");
}
~time_entry_t() throw() {
TRACE_DTOR(time_entry_t);
}
};
class time_log_t
{
std::list<time_entry_t> time_entries;
journal_t& journal;
public:
time_log_t(journal_t& _journal) : journal(_journal) {
TRACE_CTOR(time_log_t, "journal_t&");
}
~time_log_t();
void clock_in(const datetime_t& checkin,
account_t * account = NULL,
const string& desc = "");
void clock_out(const datetime_t& checkin,
account_t * account = NULL,
const string& desc = "");
};
} // namespace ledger
#endif // _TIMELOG_H