A C++ DAL / ORM code generation framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

281 lines
16 KiB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <title>WORM: Todo List</title>
  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  7. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  8. <script type="text/javascript" src="search/search.js"></script>
  9. <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10. </head>
  11. <body onload='searchBox.OnSelectItem(0);'>
  12. <!-- Generated by Doxygen 1.7.3 -->
  13. <script type="text/javascript"><!--
  14. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  15. --></script>
  16. <script type="text/javascript">
  17. function hasClass(ele,cls) {
  18. return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
  19. }
  20. function addClass(ele,cls) {
  21. if (!this.hasClass(ele,cls)) ele.className += " "+cls;
  22. }
  23. function removeClass(ele,cls) {
  24. if (hasClass(ele,cls)) {
  25. var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
  26. ele.className=ele.className.replace(reg,' ');
  27. }
  28. }
  29. function toggleVisibility(linkObj) {
  30. var base = linkObj.getAttribute('id');
  31. var summary = document.getElementById(base + '-summary');
  32. var content = document.getElementById(base + '-content');
  33. var trigger = document.getElementById(base + '-trigger');
  34. if ( hasClass(linkObj,'closed') ) {
  35. summary.style.display = 'none';
  36. content.style.display = 'block';
  37. trigger.src = 'open.png';
  38. removeClass(linkObj,'closed');
  39. addClass(linkObj,'opened');
  40. } else if ( hasClass(linkObj,'opened') ) {
  41. summary.style.display = 'block';
  42. content.style.display = 'none';
  43. trigger.src = 'closed.png';
  44. removeClass(linkObj,'opened');
  45. addClass(linkObj,'closed');
  46. }
  47. return false;
  48. }
  49. </script>
  50. <div id="top">
  51. <div id="titlearea">
  52. <table cellspacing="0" cellpadding="0">
  53. <tbody>
  54. <tr style="height: 56px;">
  55. <td id="projectlogo"><img alt="Logo" src="worm_sm.png"></td>
  56. <td style="padding-left: 0.5em;">
  57. <div id="projectname">WORM&#160;<span id="projectnumber">0.2</span></div>
  58. <div id="projectbrief">A C++ DAL/ORM code generation framework</div>
  59. </td>
  60. </tr>
  61. </tbody>
  62. </table>
  63. </div>
  64. <div id="navrow1" class="tabs">
  65. <ul class="tablist">
  66. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  67. <li class="current"><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  68. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  69. <li><a href="annotated.html"><span>Classes</span></a></li>
  70. <li><a href="files.html"><span>Files</span></a></li>
  71. <li id="searchli">
  72. <div id="MSearchBox" class="MSearchBoxInactive">
  73. <span class="left">
  74. <img id="MSearchSelect" src="search/mag_sel.png"
  75. onmouseover="return searchBox.OnSearchSelectShow()"
  76. onmouseout="return searchBox.OnSearchSelectHide()"
  77. alt=""/>
  78. <input type="text" id="MSearchField" value="Search" accesskey="S"
  79. onfocus="searchBox.OnSearchFieldFocus(true)"
  80. onblur="searchBox.OnSearchFieldFocus(false)"
  81. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  82. </span><span class="right">
  83. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  84. </span>
  85. </div>
  86. </li>
  87. </ul>
  88. </div>
  89. </div>
  90. <div class="header">
  91. <div class="headertitle">
  92. <h1>Todo List </h1> </div>
  93. </div>
  94. <div class="contents">
  95. <div class="textblock"><p><a class="anchor" id="_todo000019"></a> </p>
  96. <dl>
  97. <dt>Namespace <a class="el" href="namespace_w_sql.html">WSql</a> </dt>
  98. <dd><p class="startdd">FINISH ME .. comments </p>
  99. <p class="enddd">CHECKME ..test </p>
  100. </dd>
  101. </dl>
  102. <p><a class="anchor" id="_todo000007"></a> </p>
  103. <dl>
  104. <dt>Class <a class="el" href="class_w_sql_1_1_w_mysql_driver.html">WSql::WMysqlDriver</a> </dt>
  105. <dd>uncached results, transactions, prepared statements .. and fix string escaping...</dd>
  106. </dl>
  107. <p><a class="anchor" id="_todo000008"></a> </p>
  108. <dl>
  109. <dt>Member <a class="el" href="class_w_sql_1_1_w_mysql_driver.html#ae53e50ad703fd76da1d34a52b5a844b8">WSql::WMysqlDriver::open</a> () </dt>
  110. <dd>set connection options here, esp. utf* and friends </dd>
  111. </dl>
  112. <p><a class="anchor" id="_todo000009"></a> </p>
  113. <dl>
  114. <dt>Member <a class="el" href="class_w_sql_1_1_w_mysql_driver.html#a16cbd55969cbe2421bcc5ebe2dd0d677">WSql::WMysqlDriver::query</a> (std::string sql) </dt>
  115. <dd>RESOLVE - this also escapes LIKE quotes .. need a way to handle this, ie. a general escape/sanitizer method somewhere .. </dd>
  116. </dl>
  117. <p><a class="anchor" id="_todo000010"></a> </p>
  118. <dl>
  119. <dt>Member <a class="el" href="class_w_sql_1_1_w_mysql_driver.html#a064edf98eaa9453d358818d76627ef6b">WSql::WMysqlDriver::result</a> (bool iscached=true) </dt>
  120. <dd></dd>
  121. </dl>
  122. <p><a class="anchor" id="_todo000011"></a> </p>
  123. <dl>
  124. <dt>Member <a class="el" href="class_w_sql_1_1_w_mysql_driver.html#aa770c3b864ee481dc6d83a1d4d49a164">WSql::WMysqlDriver::tableMetaData</a> (const std::string &amp;tableName) </dt>
  125. <dd>change to use strings, defined? and test clm.setColumnName(record.field("Field").data&lt;std::string&gt;()); initColumnType(clm, record.field("Type").data&lt;std::string&gt;()); bool nullable = ! (record.field("Null").data&lt;std::string&gt;().compare("NO") == 0); bool primarykey = (record.field("Key").data&lt;std::string&gt;().compare("PRI") == 0); clm.setDefaultValue( record.field("Default").data&lt;std::string&gt;()); bool isauto = (record.field("Extra").data&lt;std::string&gt;().find("auto_increment") != std::string::npos); </dd>
  126. </dl>
  127. <p><a class="anchor" id="_todo000013"></a> </p>
  128. <dl>
  129. <dt>Class <a class="el" href="class_w_sql_1_1_w_mysql_result.html">WSql::WMysqlResult</a> </dt>
  130. <dd>uncached results if possible.</dd>
  131. </dl>
  132. <p><a class="anchor" id="_todo000004"></a> </p>
  133. <dl>
  134. <dt>Member <a class="el" href="class_w_sql_1_1_worm_class_generator.html#ae18b5f7c5d9015a1b675cdb2a6c9264c">WSql::WormClassGenerator::setOutputDirectory</a> (const std::string dir) </dt>
  135. <dd>make portable. </dd>
  136. </dl>
  137. <p><a class="anchor" id="_todo000005"></a> </p>
  138. <dl>
  139. <dt>Member <a class="el" href="class_w_sql_1_1_worm_class_generator.html#ae33fa044cc6eca45643217603f78ead2">WSql::WormClassGenerator::setTemplateDirectory</a> (const std::string dir) </dt>
  140. <dd>make portable. </dd>
  141. </dl>
  142. <p><a class="anchor" id="_todo000006"></a> </p>
  143. <dl>
  144. <dt>Member <a class="el" href="class_w_sql_1_1_worm_code_template.html#a777365c4f3a57595c2a7e350a2ed3061">WSql::WormCodeTemplate::setUri</a> (const std::string &amp;uri) </dt>
  145. <dd>NOT PORTABLE, FIXME </dd>
  146. </dl>
  147. <p><a class="anchor" id="_todo000022"></a> </p>
  148. <dl>
  149. <dt>Member <a class="el" href="class_w_sql_1_1_w_sql_column.html#a1c346bc7c3fff1c4733deb8b1a400aa5">WSql::WSqlColumn::setPrecision</a> (int precision) </dt>
  150. <dd>the note above ..</dd>
  151. </dl>
  152. <p><a class="anchor" id="_todo000021"></a> </p>
  153. <dl>
  154. <dt>Member <a class="el" href="class_w_sql_1_1_w_sql_column.html#ad90fa7cdd5fb169e29080c8a653a07d5">WSql::WSqlColumn::WSqlColumn</a> (const WSqlColumn &amp;other) </dt>
  155. <dd>test this!! </dd>
  156. </dl>
  157. <p><a class="anchor" id="_todo000023"></a> </p>
  158. <dl>
  159. <dt>Member <a class="el" href="class_w_sql_1_1_w_sql_dabatase_manager.html#aa04c72c0d0183b6df50207b2bc204d16">WSql::WSqlDabataseManager::operator==</a> (const WSqlDabataseManager &amp;other) const </dt>
  160. <dd>return ...; </dd>
  161. </dl>
  162. <p><a class="anchor" id="_todo000024"></a> </p>
  163. <dl>
  164. <dt>Member <a class="el" href="class_w_sql_1_1_w_sql_database.html#a1c943c000ea384846c7d4d77c3513afb">WSql::WSqlDatabase::hasError</a> () const </dt>
  165. <dd>resolve this - there is also the local errorStack .. </dd>
  166. </dl>
  167. <p><a class="anchor" id="_todo000025"></a> </p>
  168. <dl>
  169. <dt>Member <a class="el" href="class_w_sql_1_1_w_sql_database.html#a86df7db5900c3a2d1483375195c7b025">WSql::WSqlDatabase::tableNames</a> (<a class="el" href="namespace_w_sql.html#a2860958b4a0664bf26cd4959a7aaace8">WSql::TableType</a> type=WSql::Tables) </dt>
  170. <dd><p class="startdd">.. decide if we use this .. </p>
  171. <p class="enddd">Use the table type - currently does nothing.</p>
  172. </dd>
  173. </dl>
  174. <p><a class="anchor" id="_todo000029"></a> </p>
  175. <dl>
  176. <dt>Member <a class="el" href="namespace_w_sql_1_1_w_sql_data_type.html#a39c84fd2f9796e1f4756cd39b1f5c8b3">WSql::WSqlDataType::toPlural</a> (const std::string &amp;name) </dt>
  177. <dd>make me a little smarter .. people, fish, sheep etc. </dd>
  178. </dl>
  179. <p><a class="anchor" id="_todo000028"></a> </p>
  180. <dl>
  181. <dt>Member <a class="el" href="namespace_w_sql_1_1_w_sql_data_type.html#aaf165908fa41cfac90c81102ebfca691">WSql::WSqlDataType::toSingular</a> (const std::string &amp;name) </dt>
  182. <dd>add intelligence: std::string cmp = boost::to_lower_copy(strToReturn); if(cmp.compare("people") .. or some such .. </dd>
  183. </dl>
  184. <p><a class="anchor" id="_todo000027"></a> </p>
  185. <dl>
  186. <dt>Member <a class="el" href="namespace_w_sql_1_1_w_sql_data_type.html#acbadabc5065b07d87fac5fda92805847">WSql::WSqlDataType::toType</a> (std::string name) </dt>
  187. <dd>intelligence - support more type names, translate to ours .. </dd>
  188. </dl>
  189. <p><a class="anchor" id="_todo000031"></a> </p>
  190. <dl>
  191. <dt>Member <a class="el" href="class_w_sql_1_1_w_sql_datum.html#a11b3692a26f55c315157593158956093">WSql::WSqlDatum::data</a> () const </dt>
  192. <dd>handle exception </dd>
  193. </dl>
  194. <p><a class="anchor" id="_todo000030"></a> </p>
  195. <dl>
  196. <dt>Member <a class="el" href="class_w_sql_1_1_w_sql_datum.html#a0ce4bb3b7cfde0bd437a4943a36701f8">WSql::WSqlDatum::setData</a> (const T t) </dt>
  197. <dd>handle exception </dd>
  198. </dl>
  199. <p><a class="anchor" id="_todo000032"></a> </p>
  200. <dl>
  201. <dt>Member <a class="el" href="class_w_sql_1_1_w_sql_driver_factory.html#a54b7c1a41ff9f01c051070fae6f1155e">WSql::WSqlDriverFactory::operator==</a> (const WSqlDriverFactory &amp;other) const </dt>
  202. <dd>return ...; </dd>
  203. </dl>
  204. <p><a class="anchor" id="_todo000034"></a> </p>
  205. <dl>
  206. <dt>Member <a class="el" href="class_w_sql_1_1_w_sql_field.html#a3f48248a0281a2beb96cecde18185bd1">WSql::WSqlField::data</a> () </dt>
  207. <dd>decide if WSqlField needs/supports this (and other metadata) - also readOnly and so on .. </dd>
  208. </dl>
  209. <p><a class="anchor" id="_todo000033"></a> </p>
  210. <dl>
  211. <dt>Member <a class="el" href="class_w_sql_1_1_w_sql_field.html#a811c3e5bc9c0dad605d1bbfc1856e495">WSql::WSqlField::setData</a> (std::string s) </dt>
  212. <dd>implement that last sentence . set precision is tbd. To set the value to NULL, use clear().</dd>
  213. </dl>
  214. <p><a class="anchor" id="_todo000014"></a> </p>
  215. <dl>
  216. <dt>Class <a class="el" href="class_w_sql_1_1_w_sqlite_driver.html">WSql::WSqliteDriver</a> </dt>
  217. <dd>This driver is unfinished. Basic functionality is there but it is not, ah, elegant. Metadata is incomplete, all results are cached locally and there may be strange behavior. Basically I have done enough to get sufficient metadata for the ORM generator (except indices still) and query() will perform the query and return a result via getResult(). tableNames() works and tableMetaData() works as well (with the above caveats). Transactions are not supported and I seriously doubt that this is thread safe. It quite is crude at the moment - your milage may vary. It _might_ work for you but at this point I don't recommend it for production (10/10/2011)</dd>
  218. </dl>
  219. <p><a class="anchor" id="_todo000016"></a> </p>
  220. <dl>
  221. <dt>Member <a class="el" href="class_w_sql_1_1_w_sqlite_driver.html#a4ba7ea260dd263e74d9c16c58e655434">WSql::WSqliteDriver::query</a> (std::string sql) </dt>
  222. <dd>refactor this using metadata to construct a proper result set .. sqlite doesn't return things in orderly fashion - if a field is empty (i.e. NULL) it just doesn't include it in the results (ARG!), i _think_ and other strange random behavior is observed ..- so, we need to construct a skeleton result set from metadata and then fill it leaving the appropriate gaps such that the field name will _always_ be there. We can't simply refer to tableMetaData as it may be a join or such - which would mean parsing the query, etc..ugly The problem is that we cannot rely on sqlite to return metadata if, for instance, the query returns no results.. Consider using sqlite3_column_metadata. Also, some of this might be better moved to getResult()</dd>
  223. </dl>
  224. <p><a class="anchor" id="_todo000017"></a> </p>
  225. <dl>
  226. <dt>Member <a class="el" href="class_w_sql_1_1_w_sqlite_driver.html#aa7796f2d18f519f24016a9fa1f9e2f0b">WSql::WSqliteDriver::tableNames</a> () </dt>
  227. <dd>support table type flag .. views, information schema </dd>
  228. </dl>
  229. <p><a class="anchor" id="_todo000038"></a> </p>
  230. <dl>
  231. <dt>Member <a class="el" href="class_w_sql_1_1_w_sql_record.html#a6359bd78351e9ddb536114117c26890b">WSql::WSqlRecord::fields</a> () const </dt>
  232. <dd>THIS maybe should be const std::vector&lt;WSqlField *&gt;&amp; fields() const {return _fields;}; </dd>
  233. </dl>
  234. <p><a class="anchor" id="_todo000037"></a> </p>
  235. <dl>
  236. <dt>Member <a class="el" href="class_w_sql_1_1_w_sql_record.html#afed2c8e2bf71e773610fa57cc574b9a5">WSql::WSqlRecord::operator==</a> (const WSqlRecord &amp;other) const </dt>
  237. <dd></dd>
  238. </dl>
  239. <p><a class="anchor" id="_todo000039"></a> </p>
  240. <dl>
  241. <dt>Member <a class="el" href="class_w_sql_1_1_w_sql_record.html#ad55c83e8c1652f6acbe8ec077330b690">WSql::WSqlRecord::setNull</a> (int i) </dt>
  242. <dd>template &lt;typename t&gt;=""&gt; void setData( T t, int pos ) { </dd>
  243. </dl>
  244. <p><a class="anchor" id="_todo000036"></a> </p>
  245. <dl>
  246. <dt>Member <a class="el" href="class_w_sql_1_1_w_sql_record.html#a4d225654e0fb640a88ba0062838d4447">WSql::WSqlRecord::~WSqlRecord</a> () </dt>
  247. <dd></dd>
  248. </dl>
  249. <p><a class="anchor" id="_todo000042"></a> </p>
  250. <dl>
  251. <dt>Member <a class="el" href="class_w_sql_1_1_w_sql_result.html#ac2dd0ab98c7d237618cdd799050133c3">WSql::WSqlResult::addRecord</a> (WSqlRecord &amp;r) </dt>
  252. <dd>virtual bool operator==(const WSqlResult&amp; other) const; </dd>
  253. </dl>
  254. <p><a class="anchor" id="_todo000041"></a> </p>
  255. <dl>
  256. <dt>Member <a class="el" href="class_w_sql_1_1_w_sql_result.html#a072ee774635213477bbf28e7f8e1b8ae">WSql::WSqlResult::seek</a> (int i, bool relative=false) </dt>
  257. <dd>test this </dd>
  258. </dl>
  259. </div></div>
  260. <!--- window showing the filter options -->
  261. <div id="MSearchSelectWindow"
  262. onmouseover="return searchBox.OnSearchSelectShow()"
  263. onmouseout="return searchBox.OnSearchSelectHide()"
  264. onkeydown="return searchBox.OnSearchSelectKey(event)">
  265. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Defines</a></div>
  266. <!-- iframe showing the search results (closed by default) -->
  267. <div id="MSearchResultsWindow">
  268. <iframe src="" frameborder="0"
  269. name="MSearchResults" id="MSearchResults">
  270. </iframe>
  271. </div>
  272. <hr class="footer"/><address class="footer"><small>Generated on Fri Nov 18 2011 21:01:45 for WORM by&#160;
  273. <a href="http://www.doxygen.org/index.html">
  274. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
  275. </body>
  276. </html>