|
| 1 | +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 2 | +<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> |
| 3 | +<head> |
| 4 | +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 5 | +<meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| 6 | +<meta name="generator" content="Doxygen 1.9.8"/> |
| 7 | +<meta name="viewport" content="width=device-width, initial-scale=1"/> |
| 8 | +<title>ROSE: API.h Source File</title> |
| 9 | +<link href="tabs.css" rel="stylesheet" type="text/css"/> |
| 10 | +<script type="text/javascript" src="jquery.js"></script> |
| 11 | +<script type="text/javascript" src="dynsections.js"></script> |
| 12 | +<link href="search/search.css" rel="stylesheet" type="text/css"/> |
| 13 | +<script type="text/javascript" src="search/search.js"></script> |
| 14 | +<link rel="search" href="search_opensearch.php?v=opensearch.xml" type="application/opensearchdescription+xml" title="ROSE"/> |
| 15 | +<link href="roseDoxygen.css" rel="stylesheet" type="text/css" /> |
| 16 | +</head> |
| 17 | +<body> |
| 18 | +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 19 | +<div id="titlearea"> |
| 20 | +<table cellspacing="0" cellpadding="0"> |
| 21 | + <tbody> |
| 22 | + <tr id="projectrow"> |
| 23 | + <td id="projectalign"> |
| 24 | + <div id="projectname">ROSE<span id="projectnumber"> 0.11.145.141</span> |
| 25 | + </div> |
| 26 | + </td> |
| 27 | + </tr> |
| 28 | + </tbody> |
| 29 | +</table> |
| 30 | +</div> |
| 31 | +<!-- end header part --> |
| 32 | +<!-- Generated by Doxygen 1.9.8 --> |
| 33 | +<script type="text/javascript"> |
| 34 | +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| 35 | +var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| 36 | +/* @license-end */ |
| 37 | +</script> |
| 38 | +<script type="text/javascript" src="menudata.js"></script> |
| 39 | +<script type="text/javascript" src="menu.js"></script> |
| 40 | +<script type="text/javascript"> |
| 41 | +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| 42 | +$(function() { |
| 43 | + initMenu('',true,true,'search.html','Search'); |
| 44 | + $(document).ready(function() { |
| 45 | + if ($('.searchresults').length > 0) { searchBox.DOMSearchField().focus(); } |
| 46 | + }); |
| 47 | +}); |
| 48 | +/* @license-end */ |
| 49 | +</script> |
| 50 | +<div id="main-nav"></div> |
| 51 | +<script type="text/javascript"> |
| 52 | +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| 53 | +$(document).ready(function() { init_codefold(0); }); |
| 54 | +/* @license-end */ |
| 55 | +</script> |
| 56 | +<div id="nav-path" class="navpath"> |
| 57 | + <ul> |
| 58 | +<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_9e62d0ec1b5e35066c963e582c20357f.html">Rose</a></li><li class="navelem"><a class="el" href="dir_46ab7314654bd864a81ed1c21cd02c6f.html">CodeGen</a></li> </ul> |
| 59 | +</div> |
| 60 | +</div><!-- top --> |
| 61 | +<div class="header"> |
| 62 | + <div class="headertitle"><div class="title">API.h</div></div> |
| 63 | +</div><!--header--> |
| 64 | +<div class="contents"> |
| 65 | +<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef ROSE_CodeGen_API_H</span></div> |
| 66 | +<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define ROSE_CodeGen_API_H</span></div> |
| 67 | +<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div> |
| 68 | +<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include <Rose/CodeGen/Driver.h></span></div> |
| 69 | +<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <Rose/CodeGen/Object.h></span></div> |
| 70 | +<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div> |
| 71 | +<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include <vector></span></div> |
| 72 | +<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include <map></span></div> |
| 73 | +<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include <string></span></div> |
| 74 | +<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div> |
| 75 | +<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceRose.html">Rose</a> { <span class="keyword">namespace </span>CodeGen {</div> |
| 76 | +<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div> |
| 77 | +<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="keyword">template</span> <<span class="keyword">typename</span> CRT></div> |
| 78 | +<div class="foldopen" id="foldopen00017" data-start="{" data-end="};"> |
| 79 | +<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="classRose_1_1CodeGen_1_1API.html"> 17</a></span><span class="keyword">class </span><a class="code hl_class" href="classRose_1_1CodeGen_1_1API.html">API</a> {</div> |
| 80 | +<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">public</span>:</div> |
| 81 | +<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">using </span>a_namespace = <a class="code hl_typedef" href="namespaceRose_1_1CodeGen.html#a13d87388fa7f50bff58202dd36f09809">symbol_t<Object::a_namespace></a> *;</div> |
| 82 | +<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">using </span>a_class = <a class="code hl_typedef" href="namespaceRose_1_1CodeGen.html#a13d87388fa7f50bff58202dd36f09809">symbol_t<Object::a_class></a> *;</div> |
| 83 | +<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">using </span>a_typedef = <a class="code hl_typedef" href="namespaceRose_1_1CodeGen.html#a13d87388fa7f50bff58202dd36f09809">symbol_t<Object::a_typedef></a> *;</div> |
| 84 | +<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">using </span>a_variable = <a class="code hl_typedef" href="namespaceRose_1_1CodeGen.html#a13d87388fa7f50bff58202dd36f09809">symbol_t<Object::a_variable></a> *;</div> |
| 85 | +<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">using </span>a_function = <a class="code hl_typedef" href="namespaceRose_1_1CodeGen.html#a13d87388fa7f50bff58202dd36f09809">symbol_t<Object::a_function></a> *;</div> |
| 86 | +<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div> |
| 87 | +<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keywordtype">void</span> load(<a class="code hl_class" href="classRose_1_1CodeGen_1_1Driver.html">Driver</a> & driver);</div> |
| 88 | +<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keywordtype">void</span> display(std::ostream & out) <span class="keyword">const</span>;</div> |
| 89 | +<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div> |
| 90 | +<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordtype">void</span> add_nodes_for_namequal(<a class="code hl_class" href="classRose_1_1CodeGen_1_1Driver.html">Driver</a> & driver, <a class="code hl_class" href="classSgSourceFile.html">SgSourceFile</a> * srcfile) <span class="keyword">const</span>;</div> |
| 91 | +<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div> |
| 92 | +<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> std::set<size_t> <span class="keyword">const</span> & fids()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> file_ids; };</div> |
| 93 | +<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div> |
| 94 | +<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">private</span>: <span class="comment">// Static fields provided by user code</span></div> |
| 95 | +<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">static</span> std::string <span class="keyword">const</span> name;</div> |
| 96 | +<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div> |
| 97 | +<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// Static fields used to locate and open the header files</span></div> |
| 98 | +<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">static</span> std::string <span class="keyword">const</span> cache;</div> |
| 99 | +<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">static</span> std::vector<std::string> <span class="keyword">const</span> paths;</div> |
| 100 | +<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">static</span> std::vector<std::string> <span class="keyword">const</span> files;</div> |
| 101 | +<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">static</span> std::vector<std::string> <span class="keyword">const</span> flags;</div> |
| 102 | +<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div> |
| 103 | +<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// Object maps used to load API elements into the CRT "sub-class" (introspection of sort)</span></div> |
| 104 | +<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">static</span> std::map<std::string, a_namespace CRT::* > <span class="keyword">const</span> namespaces;</div> |
| 105 | +<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">static</span> std::map<std::string, a_class CRT::* > <span class="keyword">const</span> classes;</div> |
| 106 | +<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">static</span> std::map<std::string, a_typedef CRT::* > <span class="keyword">const</span> typedefs;</div> |
| 107 | +<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">static</span> std::map<std::string, a_variable CRT::* > <span class="keyword">const</span> variables;</div> |
| 108 | +<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">static</span> std::map<std::string, a_function CRT::* > <span class="keyword">const</span> functions;</div> |
| 109 | +<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div> |
| 110 | +<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">private</span>:</div> |
| 111 | +<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> std::set<size_t> file_ids;</div> |
| 112 | +<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div> |
| 113 | +<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keywordtype">void</span> set_command_line(<a class="code hl_class" href="classRose_1_1CodeGen_1_1Driver.html">Driver</a> & driver) <span class="keyword">const</span>;</div> |
| 114 | +<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordtype">void</span> load_headers(<a class="code hl_class" href="classRose_1_1CodeGen_1_1Driver.html">Driver</a> & driver);</div> |
| 115 | +<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keywordtype">void</span> load_api(<a class="code hl_class" href="classRose_1_1CodeGen_1_1Driver.html">Driver</a> & driver);</div> |
| 116 | +<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div> |
| 117 | +<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">template</span> <<span class="keyword">typename</span> API></div> |
| 118 | +<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">friend</span> <span class="keyword">struct </span>SymbolScanner;</div> |
| 119 | +<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>};</div> |
| 120 | +</div> |
| 121 | +<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div> |
| 122 | +<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span>} }</div> |
| 123 | +<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div> |
| 124 | +<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="preprocessor">#include "Rose/CodeGen/API.txx"</span></div> |
| 125 | +<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div> |
| 126 | +<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="preprocessor">#endif</span></div> |
| 127 | +<div class="ttc" id="aclassRose_1_1CodeGen_1_1API_html"><div class="ttname"><a href="classRose_1_1CodeGen_1_1API.html">Rose::CodeGen::API</a></div><div class="ttdoc">permits to gather types and symbols to extract an API from a set of headers.</div><div class="ttdef"><b>Definition</b> <a href="API_8h_source.html#l00017">API.h:17</a></div></div> |
| 128 | +<div class="ttc" id="aclassRose_1_1CodeGen_1_1Driver_html"><div class="ttname"><a href="classRose_1_1CodeGen_1_1Driver.html">Rose::CodeGen::Driver</a></div><div class="ttdoc">facilitates the manipulation of source-files (esp.</div><div class="ttdef"><b>Definition</b> <a href="Driver_8h_source.html#l00022">Driver.h:22</a></div></div> |
| 129 | +<div class="ttc" id="aclassSgSourceFile_html"><div class="ttname"><a href="classSgSourceFile.html">SgSourceFile</a></div><div class="ttdef"><b>Definition</b> <a href="Cxx__Grammar_8h_source.html#l34638">Cxx_Grammar.h:34639</a></div></div> |
| 130 | +<div class="ttc" id="anamespaceRose_1_1CodeGen_html_a13d87388fa7f50bff58202dd36f09809"><div class="ttname"><a href="namespaceRose_1_1CodeGen.html#a13d87388fa7f50bff58202dd36f09809">Rose::CodeGen::symbol_t</a></div><div class="ttdeci">typename object_helper< otag >::symbol_t symbol_t</div><div class="ttdoc">The SgSymbol specialization for an Object kind /tparam otag an Object kind.</div><div class="ttdef"><b>Definition</b> <a href="Object_8h_source.html#l00027">Object.h:27</a></div></div> |
| 131 | +<div class="ttc" id="anamespaceRose_html"><div class="ttname"><a href="namespaceRose.html">Rose</a></div><div class="ttdoc">The ROSE library.</div><div class="ttdef"><b>Definition</b> <a href="BinaryTutorial_8dox_source.html#l00003">BinaryTutorial.dox:3</a></div></div> |
| 132 | +</div><!-- fragment --></div><!-- contents --> |
| 133 | +<!-- start footer part --> |
| 134 | +<hr class="footer"/><address class="footer"><small> |
| 135 | +Generated on Wed Oct 2 2024 00:08:25 for ROSE by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 |
| 136 | +</small></address> |
| 137 | +</body> |
| 138 | +</html> |
0 commit comments