<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[13295] PyCalendar/trunk/src/pycalendar/property.py</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.calendarserver.org//changeset/13295">13295</a></dd>
<dt>Author</dt> <dd>cdaboo@apple.com</dd>
<dt>Date</dt> <dd>2014-04-16 06:56:29 -0700 (Wed, 16 Apr 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add option to always emit the VALUE= parameter even when the value type is the default.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#PyCalendartrunksrcpycalendarpropertypy">PyCalendar/trunk/src/pycalendar/property.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="PyCalendartrunksrcpycalendarpropertypy"></a>
<div class="modfile"><h4>Modified: PyCalendar/trunk/src/pycalendar/property.py (13294 => 13295)</h4>
<pre class="diff"><span>
<span class="info">--- PyCalendar/trunk/src/pycalendar/property.py 2014-04-16 01:00:56 UTC (rev 13294)
+++ PyCalendar/trunk/src/pycalendar/property.py 2014-04-16 13:56:29 UTC (rev 13295)
</span><span class="lines">@@ -36,10 +36,24 @@
</span><span class="cx"> class PropertyBase(object):
</span><span class="cx">
</span><span class="cx"> # Mappings between various tokens and internal definitions
</span><ins>+
+ # Map a property name to its default value type
</ins><span class="cx"> sDefaultValueTypeMap = {}
</span><ins>+
+ # Properties whose value parameter is always written out
+ # even if equal to the default
+ sAlwaysValueTypes = set()
+
+ # Map a value name to a value type constant
</ins><span class="cx"> sValueTypeMap = {}
</span><ins>+
+ # Map a value type constant to a value name
</ins><span class="cx"> sTypeValueMap = {}
</span><ins>+
+ # Properties that are multi-valued
</ins><span class="cx"> sMultiValues = set()
</span><ins>+
+ # Properties whose value needs special handling
</ins><span class="cx"> sSpecialVariants = {}
</span><span class="cx">
</span><span class="cx"> sUsesGroup = False
</span><span class="lines">@@ -50,9 +64,22 @@
</span><span class="cx"> sText = None
</span><span class="cx">
</span><span class="cx"> @classmethod
</span><del>- def registerDefaultValue(cls, propname, valuetype):
</del><ins>+ def registerDefaultValue(cls, propname, valuetype, always_write_value=False):
+ """
+ Allow custom properties to be used by defining their name/value mappings.
+
+ @param propname: name of the new property
+ @type propname: L{str}
+ @param valuetype: the L{Value} type used as the default value
+ @type valuetype: L{int}
+ @param always_write_value: if L{True} always write a VALUE= parameter even
+ when the default value is used
+ @type always_write_value: L{bool}
+ """
</ins><span class="cx"> if propname not in cls.sDefaultValueTypeMap:
</span><span class="cx"> cls.sDefaultValueTypeMap[propname] = valuetype
</span><ins>+ if always_write_value:
+ cls.sAlwaysValueTypes.add(propname)
</ins><span class="cx">
</span><span class="cx">
</span><span class="cx"> def __init__(self, name=None, value=None, valuetype=None):
</span><span class="lines">@@ -601,13 +628,14 @@
</span><span class="cx"> return
</span><span class="cx">
</span><span class="cx"> # See if current type is default for this property. If there is no mapping available,
</span><del>- # then always add VALUE if it is not TEXT.
</del><ins>+ # then always add VALUE if it is not TEXT. Always add the value if listed in the
+ # C{sAlwaysValueTypes} attribute.
</ins><span class="cx"> default_type = self.sDefaultValueTypeMap.get(self.mName.upper())
</span><span class="cx"> if self.mName.upper() in self.sSpecialVariants:
</span><span class="cx"> actual_type = default_type
</span><span class="cx"> else:
</span><span class="cx"> actual_type = self.mValue.getType()
</span><del>- if default_type is None or default_type != actual_type:
</del><ins>+ if default_type is None or default_type != actual_type or self.mName.upper() in self.sAlwaysValueTypes:
</ins><span class="cx"> actual_value = self.sTypeValueMap.get(actual_type)
</span><span class="cx"> if actual_value is not None and (default_type is not None or actual_type != Value.VALUETYPE_TEXT):
</span><span class="cx"> self.mParameters.setdefault(self.sValue, []).append(Parameter(name=self.sValue, value=actual_value))
</span></span></pre>
</div>
</div>
</body>
</html>