[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-core-devel
Subject: Re: Review Request: Add new KDate class to simplify date localization
From: "Sebastian Trueg" <trueg () kde ! org>
Date: 2010-10-26 8:21:05
Message-ID: 20101026082105.22669.58792 () vidsolbach ! de
[Download RAW message or body]
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
http://svn.reviewboard.kde.org/r/5692/#review8358
-----------------------------------------------------------
/trunk/KDE/kdelibs/kdecore/date/kdate.h
<http://svn.reviewboard.kde.org/r/5692/#comment8642>
there is no locale parameter here.
/trunk/KDE/kdelibs/kdecore/date/kdate.h
<http://svn.reviewboard.kde.org/r/5692/#comment8647>
one "the" too many
/trunk/KDE/kdelibs/kdecore/date/kdate.h
<http://svn.reviewboard.kde.org/r/5692/#comment8648>
one "the" too many
/trunk/KDE/kdelibs/kdecore/date/kdate.h
<http://svn.reviewboard.kde.org/r/5692/#comment8649>
Could this not be a QDate return type instead of pointers?
/trunk/KDE/kdelibs/kdecore/date/kdate.h
<http://svn.reviewboard.kde.org/r/5692/#comment8650>
an example would be good here since it is rather unclear what the method (and its \
friends below) return.
/trunk/KDE/kdelibs/kdecore/date/kdate.h
<http://svn.reviewboard.kde.org/r/5692/#comment8651>
Confusing that this is not a static method.
- Sebastian
On 2010-10-25 20:54:08, John Layt wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://svn.reviewboard.kde.org/r/5692/
> -----------------------------------------------------------
>
> (Updated 2010-10-25 20:54:08)
>
>
> Review request for kdelibs.
>
>
> Summary
> -------
>
> The KCalendarSystem api for localizing dates is awkward, inconvenient, unintuitive, \
> and long-winded, causing many mistakes to be made or localization to be ignored \
> altogether. This change adds a new KDate class designed to make localizing dates \
> as easy as using QDate.
> Some QDate code may look like:
>
> QDate myDate( aYear, aMonth, aDay );
> int doy = myDate.dayOfYear();
>
> The KDE localized date code looks something like:
>
> QDate myDate;
> KGlobal::locale()->calendar()->setDate( myDate, aYear, aMonth, aDay );
> int doy = KGlobal::locale()->calendar()->dayOfYear( myDate );
>
> The localized KDate code would look like:
>
> KDate myDate( aYear, aMonth, aDay );
> int doy = myDate.dayOfYear();
>
> Much easier.
>
> KDate is a thin wrapper around KCalendarSystem and QDate, with a near identical api \
> to QDate and as such can be used as a drop-in replacement with very few changes. \
> Some deprecated or unnecessary KCalendarSystem methods have not been included, but \
> these can still be accessed via the calendar() methods. Some new convenience \
> methods have also been added such as setCurrentDate() and addYearsOn().
> Some methods have QDate overloads for convenience, and the assignment and \
> comparison operators partially work with QDate on the rhs. If anyone knows how to \
> make it work with QDate on the lhs, or any other QDate compatibility ideas, I'm all \
> ears.
> For now I only intend this to be used as a convenience class by apps internally and \
> not to be used in kdelibs api as I don't see much advantage in that, but I may do \
> so if the demand for convenience is there.
> I have named it KDate, but there is the possibility people may get confused and \
> think that KDateTime also localizes datetime's, but that is not the case. If \
> people think this will be a problem KLocalizedDate is an alternative if more \
> awkward name.
>
> Diffs
> -----
>
> /trunk/KDE/kdelibs/kdecore/CMakeLists.txt 1189756
> /trunk/KDE/kdelibs/kdecore/date/kdate.h PRE-CREATION
> /trunk/KDE/kdelibs/kdecore/date/kdate.cpp PRE-CREATION
> /trunk/KDE/kdelibs/kdecore/tests/kcalendartest.h 1189756
> /trunk/KDE/kdelibs/kdecore/tests/kcalendartest.cpp 1189756
>
> Diff: http://svn.reviewboard.kde.org/r/5692/diff
>
>
> Testing
> -------
>
> Full unit tests included.
>
>
> Thanks,
>
> John
>
>
[Attachment #3 (text/html)]
<html>
<body>
<div style="font-family: Verdana, Arial, Helvetica, Sans-Serif;">
<table bgcolor="#f9f3c9" width="100%" cellpadding="8" style="border: 1px #c9c399 \
solid;"> <tr>
<td>
This is an automatically generated e-mail. To reply, visit:
<a href="http://svn.reviewboard.kde.org/r/5692/">http://svn.reviewboard.kde.org/r/5692/</a>
</td>
</tr>
</table>
<br />
<div>
<table width="100%" border="0" bgcolor="white" style="border: 1px solid #C0C0C0; \
border-collapse: collapse; margin: 2px padding: 2px;"> <thead>
<tr>
<th colspan="4" bgcolor="#F0F0F0" style="border-bottom: 1px solid #C0C0C0; \
font-size: 9pt; padding: 4px 8px; text-align: left;"> <a \
href="http://svn.reviewboard.kde.org/r/5692/diff/1/?file=40246#file40246line57" \
style="color: black; font-weight: bold; text-decoration: \
underline;">/trunk/KDE/kdelibs/kdecore/date/kdate.h</a> <span style="font-weight: \
normal;">
(Diff revision 1)
</span>
</th>
</tr>
</thead>
<tbody style="background-color: #e4d9cb; padding: 4px 8px; text-align: center;">
<tr>
<td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: 0; \
"></pre></td> <td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: \
0; ">public:</pre></td>
</tr>
</tbody>
<tbody>
<tr>
<th bgcolor="#b1ebb0" style="border-right: 1px solid #C0C0C0;" \
align="right"><font size="2"></font></th> <td bgcolor="#c5ffc4" width="50%"><pre \
style="font-size: 8pt; line-height: 140%; margin: 0; "></pre></td> <th \
bgcolor="#b1ebb0" style="border-left: 1px solid #C0C0C0; border-right: 1px solid \
#C0C0C0;" align="right"><font size="2">57</font></th> <td bgcolor="#c5ffc4" \
width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "><span \
class="cm"> * @param locale locale to use for translations. The global locale is \
used if null.</span></pre></td> </tr>
</tbody>
</table>
<pre style="margin-left: 2em; white-space: pre-wrap; white-space: -moz-pre-wrap; \
white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">there is no \
locale parameter here.</pre> </div>
<br />
<div>
<table width="100%" border="0" bgcolor="white" style="border: 1px solid #C0C0C0; \
border-collapse: collapse; margin: 2px padding: 2px;"> <thead>
<tr>
<th colspan="4" bgcolor="#F0F0F0" style="border-bottom: 1px solid #C0C0C0; \
font-size: 9pt; padding: 4px 8px; text-align: left;"> <a \
href="http://svn.reviewboard.kde.org/r/5692/diff/1/?file=40246#file40246line302" \
style="color: black; font-weight: bold; text-decoration: \
underline;">/trunk/KDE/kdelibs/kdecore/date/kdate.h</a> <span style="font-weight: \
normal;">
(Diff revision 1)
</span>
</th>
</tr>
</thead>
<tbody style="background-color: #e4d9cb; padding: 4px 8px; text-align: center;">
<tr>
<td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: 0; \
"></pre></td> <td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: \
0; ">public:</pre></td>
</tr>
</tbody>
<tbody>
<tr>
<th bgcolor="#b1ebb0" style="border-right: 1px solid #C0C0C0;" \
align="right"><font size="2"></font></th> <td bgcolor="#c5ffc4" width="50%"><pre \
style="font-size: 8pt; line-height: 140%; margin: 0; "></pre></td> <th \
bgcolor="#b1ebb0" style="border-left: 1px solid #C0C0C0; border-right: 1px solid \
#C0C0C0;" align="right"><font size="2">302</font></th> <td bgcolor="#c5ffc4" \
width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "><span \
class="cm"> * The the result of the addition is invalid then the date will become \
invalid.</span></pre></td> </tr>
</tbody>
</table>
<pre style="margin-left: 2em; white-space: pre-wrap; white-space: -moz-pre-wrap; \
white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">one \
"the" too many</pre> </div>
<br />
<div>
<table width="100%" border="0" bgcolor="white" style="border: 1px solid #C0C0C0; \
border-collapse: collapse; margin: 2px padding: 2px;"> <thead>
<tr>
<th colspan="4" bgcolor="#F0F0F0" style="border-bottom: 1px solid #C0C0C0; \
font-size: 9pt; padding: 4px 8px; text-align: left;"> <a \
href="http://svn.reviewboard.kde.org/r/5692/diff/1/?file=40246#file40246line320" \
style="color: black; font-weight: bold; text-decoration: \
underline;">/trunk/KDE/kdelibs/kdecore/date/kdate.h</a> <span style="font-weight: \
normal;">
(Diff revision 1)
</span>
</th>
</tr>
</thead>
<tbody style="background-color: #e4d9cb; padding: 4px 8px; text-align: center;">
<tr>
<td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: 0; \
"></pre></td> <td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: \
0; ">public:</pre></td>
</tr>
</tbody>
<tbody>
<tr>
<th bgcolor="#b1ebb0" style="border-right: 1px solid #C0C0C0;" \
align="right"><font size="2"></font></th> <td bgcolor="#c5ffc4" width="50%"><pre \
style="font-size: 8pt; line-height: 140%; margin: 0; "></pre></td> <th \
bgcolor="#b1ebb0" style="border-left: 1px solid #C0C0C0; border-right: 1px solid \
#C0C0C0;" align="right"><font size="2">320</font></th> <td bgcolor="#c5ffc4" \
width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "><span \
class="cm"> * The the result of the addition is invalid then the date will become \
invalid.</span></pre></td> </tr>
</tbody>
</table>
<pre style="margin-left: 2em; white-space: pre-wrap; white-space: -moz-pre-wrap; \
white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">one \
"the" too many</pre> </div>
<br />
<div>
<table width="100%" border="0" bgcolor="white" style="border: 1px solid #C0C0C0; \
border-collapse: collapse; margin: 2px padding: 2px;"> <thead>
<tr>
<th colspan="4" bgcolor="#F0F0F0" style="border-bottom: 1px solid #C0C0C0; \
font-size: 9pt; padding: 4px 8px; text-align: left;"> <a \
href="http://svn.reviewboard.kde.org/r/5692/diff/1/?file=40246#file40246line362" \
style="color: black; font-weight: bold; text-decoration: \
underline;">/trunk/KDE/kdelibs/kdecore/date/kdate.h</a> <span style="font-weight: \
normal;">
(Diff revision 1)
</span>
</th>
</tr>
</thead>
<tbody style="background-color: #e4d9cb; padding: 4px 8px; text-align: center;">
<tr>
<td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: 0; \
"></pre></td> <td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: \
0; ">public:</pre></td>
</tr>
</tbody>
<tbody>
<tr>
<th bgcolor="#b1ebb0" style="border-right: 1px solid #C0C0C0;" \
align="right"><font size="2"></font></th> <td bgcolor="#c5ffc4" width="50%"><pre \
style="font-size: 8pt; line-height: 140%; margin: 0; "></pre></td> <th \
bgcolor="#b1ebb0" style="border-left: 1px solid #C0C0C0; border-right: 1px solid \
#C0C0C0;" align="right"><font size="2">362</font></th> <td bgcolor="#c5ffc4" \
width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "> <span \
class="kt">void</span> <span class="n">dateDifference</span><span \
class="p">(</span><span class="k">const</span> <span class="n">KDate</span> <span \
class="o">&</span><span class="n">toDate</span><span \
class="p">,</span></pre></td> </tr>
</tbody>
</table>
<pre style="margin-left: 2em; white-space: pre-wrap; white-space: -moz-pre-wrap; \
white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">Could this \
not be a QDate return type instead of pointers?</pre> </div>
<br />
<div>
<table width="100%" border="0" bgcolor="white" style="border: 1px solid #C0C0C0; \
border-collapse: collapse; margin: 2px padding: 2px;"> <thead>
<tr>
<th colspan="4" bgcolor="#F0F0F0" style="border-bottom: 1px solid #C0C0C0; \
font-size: 9pt; padding: 4px 8px; text-align: left;"> <a \
href="http://svn.reviewboard.kde.org/r/5692/diff/1/?file=40246#file40246line607" \
style="color: black; font-weight: bold; text-decoration: \
underline;">/trunk/KDE/kdelibs/kdecore/date/kdate.h</a> <span style="font-weight: \
normal;">
(Diff revision 1)
</span>
</th>
</tr>
</thead>
<tbody style="background-color: #e4d9cb; padding: 4px 8px; text-align: center;">
<tr>
<td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: 0; \
"></pre></td> <td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: \
0; ">public:</pre></td>
</tr>
</tbody>
<tbody>
<tr>
<th bgcolor="#b1ebb0" style="border-right: 1px solid #C0C0C0;" \
align="right"><font size="2"></font></th> <td bgcolor="#c5ffc4" width="50%"><pre \
style="font-size: 8pt; line-height: 140%; margin: 0; "></pre></td> <th \
bgcolor="#b1ebb0" style="border-left: 1px solid #C0C0C0; border-right: 1px solid \
#C0C0C0;" align="right"><font size="2">607</font></th> <td bgcolor="#c5ffc4" \
width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "> <span \
class="n">QString</span> <span class="n">dayOfYearString</span><span \
class="p">(</span><span class="n">KCalendarSystem</span><span \
class="o">::</span><span class="n">StringFormat</span> <span class="n">format</span> \
<span class="o">=</span> <span class="n">KCalendarSystem</span><span \
class="o">::</span><span class="n">LongFormat</span><span class="p">)</span> <span \
class="k">const</span><span class="p">;</span></pre></td> </tr>
</tbody>
</table>
<pre style="margin-left: 2em; white-space: pre-wrap; white-space: -moz-pre-wrap; \
white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">an example \
would be good here since it is rather unclear what the method (and its friends below) \
return.</pre> </div>
<br />
<div>
<table width="100%" border="0" bgcolor="white" style="border: 1px solid #C0C0C0; \
border-collapse: collapse; margin: 2px padding: 2px;"> <thead>
<tr>
<th colspan="4" bgcolor="#F0F0F0" style="border-bottom: 1px solid #C0C0C0; \
font-size: 9pt; padding: 4px 8px; text-align: left;"> <a \
href="http://svn.reviewboard.kde.org/r/5692/diff/1/?file=40246#file40246line736" \
style="color: black; font-weight: bold; text-decoration: \
underline;">/trunk/KDE/kdelibs/kdecore/date/kdate.h</a> <span style="font-weight: \
normal;">
(Diff revision 1)
</span>
</th>
</tr>
</thead>
<tbody style="background-color: #e4d9cb; padding: 4px 8px; text-align: center;">
<tr>
<td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: 0; \
"></pre></td> <td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: \
0; ">public:</pre></td>
</tr>
</tbody>
<tbody>
<tr>
<th bgcolor="#b1ebb0" style="border-right: 1px solid #C0C0C0;" \
align="right"><font size="2"></font></th> <td bgcolor="#c5ffc4" width="50%"><pre \
style="font-size: 8pt; line-height: 140%; margin: 0; "></pre></td> <th \
bgcolor="#b1ebb0" style="border-left: 1px solid #C0C0C0; border-right: 1px solid \
#C0C0C0;" align="right"><font size="2">736</font></th> <td bgcolor="#c5ffc4" \
width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "> <span \
class="n">KDate</span> <span class="n">readDate</span><span class="p">(</span><span \
class="k">const</span> <span class="n">QString</span> <span \
class="o">&</span><span class="n">dateString</span><span class="p">,</span> <span \
class="n">bool</span> <span class="o">*</span><span class="n">ok</span> <span \
class="o">=</span> <span class="mi">0</span><span class="p">)</span> <span \
class="k">const</span><span class="p">;</span></pre></td> </tr>
</tbody>
</table>
<pre style="margin-left: 2em; white-space: pre-wrap; white-space: -moz-pre-wrap; \
white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">Confusing \
that this is not a static method.</pre> </div>
<br />
<p>- Sebastian</p>
<br />
<p>On October 25th, 2010, 8:54 p.m., John Layt wrote:</p>
<table bgcolor="#fefadf" width="100%" cellspacing="0" cellpadding="8" \
style="background-image: \
url('http://svn.reviewboard.kde.orgrb/images/review_request_box_top_bg.png'); \
background-position: left top; background-repeat: repeat-x; border: 1px black \
solid;"> <tr>
<td>
<div>Review request for kdelibs.</div>
<div>By John Layt.</div>
<p style="color: grey;"><i>Updated 2010-10-25 20:54:08</i></p>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Description </h1>
<table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" style="border: \
1px solid #b8b5a0"> <tr>
<td>
<pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;">The KCalendarSystem api for localizing dates is awkward, inconvenient, \
unintuitive, and long-winded, causing many mistakes to be made or localization to be \
ignored altogether. This change adds a new KDate class designed to make localizing \
dates as easy as using QDate.
Some QDate code may look like:
QDate myDate( aYear, aMonth, aDay );
int doy = myDate.dayOfYear();
The KDE localized date code looks something like:
QDate myDate;
KGlobal::locale()->calendar()->setDate( myDate, aYear, aMonth, aDay );
int doy = KGlobal::locale()->calendar()->dayOfYear( myDate );
The localized KDate code would look like:
KDate myDate( aYear, aMonth, aDay );
int doy = myDate.dayOfYear();
Much easier.
KDate is a thin wrapper around KCalendarSystem and QDate, with a near identical api \
to QDate and as such can be used as a drop-in replacement with very few changes. \
Some deprecated or unnecessary KCalendarSystem methods have not been included, but \
these can still be accessed via the calendar() methods. Some new convenience methods \
have also been added such as setCurrentDate() and addYearsOn().
Some methods have QDate overloads for convenience, and the assignment and comparison \
operators partially work with QDate on the rhs. If anyone knows how to make it work \
with QDate on the lhs, or any other QDate compatibility ideas, I'm all ears.
For now I only intend this to be used as a convenience class by apps internally and \
not to be used in kdelibs api as I don't see much advantage in that, but I may do \
so if the demand for convenience is there.
I have named it KDate, but there is the possibility people may get confused and think \
that KDateTime also localizes datetime's, but that is not the case. If people \
think this will be a problem KLocalizedDate is an alternative if more awkward \
name.</pre> </td>
</tr>
</table>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Testing </h1>
<table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" style="border: \
1px solid #b8b5a0"> <tr>
<td>
<pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;">Full unit tests included.</pre> </td>
</tr>
</table>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Diffs</b> </h1>
<ul style="margin-left: 3em; padding-left: 0;">
<li>/trunk/KDE/kdelibs/kdecore/CMakeLists.txt <span style="color: \
grey">(1189756)</span></li>
<li>/trunk/KDE/kdelibs/kdecore/date/kdate.h <span style="color: \
grey">(PRE-CREATION)</span></li>
<li>/trunk/KDE/kdelibs/kdecore/date/kdate.cpp <span style="color: \
grey">(PRE-CREATION)</span></li>
<li>/trunk/KDE/kdelibs/kdecore/tests/kcalendartest.h <span style="color: \
grey">(1189756)</span></li>
<li>/trunk/KDE/kdelibs/kdecore/tests/kcalendartest.cpp <span style="color: \
grey">(1189756)</span></li>
</ul>
<p><a href="http://svn.reviewboard.kde.org/r/5692/diff/" style="margin-left: \
3em;">View Diff</a></p>
</td>
</tr>
</table>
</div>
</body>
</html>
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic