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<meta http-equiv="X-UA-Compatible" content="IE=9"/> 6<meta name="generator" content="Doxygen 1.8.14"/> 7<meta name="viewport" content="width=device-width, initial-scale=1"/> 8<title>Magick++: Blob.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="navtree.css" rel="stylesheet" type="text/css"/> 13<script type="text/javascript" src="resize.js"></script> 14<script type="text/javascript" src="navtreedata.js"></script> 15<script type="text/javascript" src="navtree.js"></script> 16<script type="text/javascript"> 17/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 18 $(document).ready(initResizable); 19/* @license-end */</script> 20<link href="doxygen.css" rel="stylesheet" type="text/css" /> 21</head> 22<body> 23<div id="top"><!-- do not remove this div, it is closed by doxygen! --> 24<div id="titlearea"> 25<table cellspacing="0" cellpadding="0"> 26 <tbody> 27 <tr style="height: 56px;"> 28 <td id="projectalign" style="padding-left: 0.5em;"> 29 <div id="projectname">Magick++ 30  <span id="projectnumber">7.0.10</span> 31 </div> 32 </td> 33 </tr> 34 </tbody> 35</table> 36</div> 37<!-- end header part --> 38<!-- Generated by Doxygen 1.8.14 --> 39</div><!-- top --> 40<div id="side-nav" class="ui-resizable side-nav-resizable"> 41 <div id="nav-tree"> 42 <div id="nav-tree-contents"> 43 <div id="nav-sync" class="sync"></div> 44 </div> 45 </div> 46 <div id="splitbar" style="-moz-user-select:none;" 47 class="ui-resizable-handle"> 48 </div> 49</div> 50<script type="text/javascript"> 51/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 52$(document).ready(function(){initNavTree('Blob_8h_source.html','');}); 53/* @license-end */ 54</script> 55<div id="doc-content"> 56<div class="header"> 57 <div class="headertitle"> 58<div class="title">Blob.h</div> </div> 59</div><!--header--> 60<div class="contents"> 61<a href="Blob_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// This may look like C code, but it is really -*- C++ -*-</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">//</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// Copyright Bob Friesenhahn, 1999, 2000, 2001, 2002</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Copyright Dirk Lemstra 2015</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">//</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// Reference counted container class for Binary Large Objects (BLOBs)</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#if !defined(Magick_BlobRef_header)</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#define Magick_BlobRef_header</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "<a class="code" href="Include_8h.html">Magick++/Include.h</a>"</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="namespaceMagick.html"> 15</a></span> <span class="keyword">namespace </span><a class="code" href="namespaceMagick.html">Magick</a></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> {</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="comment">// Forward decl</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="keyword">class </span><a class="code" href="classMagick_1_1BlobRef.html">BlobRef</a>;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="classMagick_1_1Blob.html"> 20</a></span>  <span class="keyword">class </span><a class="code" href="Include_8h.html#a3648b581d4f8adf56a18ae67b7111a04">MagickPPExport</a> <a class="code" href="classMagick_1_1Blob.html">Blob</a></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classMagick_1_1Blob.html#a320f999fa1ed7e9ee0e6f28858499e2e"> 24</a></span>  <span class="keyword">enum</span> <a class="code" href="classMagick_1_1Blob.html#a320f999fa1ed7e9ee0e6f28858499e2e">Allocator</a></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  {</div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classMagick_1_1Blob.html#a320f999fa1ed7e9ee0e6f28858499e2eadd73c6a4bf2388460e3df6141a24fe2a"> 26</a></span>  <a class="code" href="classMagick_1_1Blob.html#a320f999fa1ed7e9ee0e6f28858499e2eadd73c6a4bf2388460e3df6141a24fe2a">MallocAllocator</a>,</div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classMagick_1_1Blob.html#a320f999fa1ed7e9ee0e6f28858499e2ea8dfea41b347695cd3ee8cb88cc7123dd"> 27</a></span>  NewAllocator</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  };</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="comment">// Default constructor</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="classMagick_1_1Blob.html">Blob</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">// Construct object with data, making a copy of the supplied data.</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <a class="code" href="classMagick_1_1Blob.html">Blob</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* data_,<span class="keyword">const</span> <span class="keywordtype">size_t</span> length_);</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="comment">// Copy constructor (reference counted)</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <a class="code" href="classMagick_1_1Blob.html">Blob</a>(<span class="keyword">const</span> <a class="code" href="classMagick_1_1Blob.html">Blob</a>& blob_);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="comment">// Destructor (reference counted)</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">virtual</span> ~<a class="code" href="classMagick_1_1Blob.html">Blob</a>();</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">// Assignment operator (reference counted)</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="classMagick_1_1Blob.html">Blob</a>& operator=(<span class="keyword">const</span> <a class="code" href="classMagick_1_1Blob.html">Blob</a>& blob_);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="comment">// Update object contents from Base64-encoded string representation.</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">void</span> base64(<span class="keyword">const</span> std::string base64_);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">// Return Base64-encoded string representation.</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  std::string base64(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="comment">// Obtain pointer to data. The user should never try to modify or</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">// free this data since the Blob class manages its own data. The</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// user must be finished with the data before allowing the Blob to</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">// be destroyed since the pointer is invalid once the Blob is</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// destroyed.</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">const</span> <span class="keywordtype">void</span>* data(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// Obtain data length.</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">size_t</span> length(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">// Update object contents, making a copy of the supplied data.</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">// Any existing data in the object is deallocated.</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">void</span> update(<span class="keyword">const</span> <span class="keywordtype">void</span>* data_,<span class="keyword">const</span> <span class="keywordtype">size_t</span> length_);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">// Update object contents, using supplied pointer directly (no</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="comment">// copy). Any existing data in the object is deallocated. The user</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="comment">// must ensure that the pointer supplied is not deleted or</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">// otherwise modified after it has been supplied to this method.</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="comment">// Specify allocator_ as "MallocAllocator" if memory is allocated</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">// via the C language malloc() function, or "NewAllocator" if</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// memory is allocated via C++ 'new'.</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">void</span> updateNoCopy(<span class="keywordtype">void</span>* data_,<span class="keyword">const</span> <span class="keywordtype">size_t</span> length_,</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">const</span> Allocator allocator_=NewAllocator);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <a class="code" href="classMagick_1_1BlobRef.html">BlobRef</a> *_blobRef;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  };</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> } <span class="comment">// namespace Magick</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor">#endif // Magick_BlobRef_header</span></div><div class="ttc" id="classMagick_1_1Blob_html_a320f999fa1ed7e9ee0e6f28858499e2eadd73c6a4bf2388460e3df6141a24fe2a"><div class="ttname"><a href="classMagick_1_1Blob.html#a320f999fa1ed7e9ee0e6f28858499e2eadd73c6a4bf2388460e3df6141a24fe2a">Magick::Blob::MallocAllocator</a></div><div class="ttdef"><b>Definition:</b> <a href="Blob_8h_source.html#l00026">Blob.h:26</a></div></div> 62<div class="ttc" id="classMagick_1_1Blob_html"><div class="ttname"><a href="classMagick_1_1Blob.html">Magick::Blob</a></div><div class="ttdef"><b>Definition:</b> <a href="Blob_8h_source.html#l00020">Blob.h:20</a></div></div> 63<div class="ttc" id="Include_8h_html_a3648b581d4f8adf56a18ae67b7111a04"><div class="ttname"><a href="Include_8h.html#a3648b581d4f8adf56a18ae67b7111a04">MagickPPExport</a></div><div class="ttdeci">#define MagickPPExport</div><div class="ttdef"><b>Definition:</b> <a href="Include_8h_source.html#l00281">Include.h:281</a></div></div> 64<div class="ttc" id="Include_8h_html"><div class="ttname"><a href="Include_8h.html">Include.h</a></div></div> 65<div class="ttc" id="classMagick_1_1BlobRef_html"><div class="ttname"><a href="classMagick_1_1BlobRef.html">Magick::BlobRef</a></div><div class="ttdef"><b>Definition:</b> <a href="BlobRef_8h_source.html#l00021">BlobRef.h:21</a></div></div> 66<div class="ttc" id="classMagick_1_1Blob_html_a320f999fa1ed7e9ee0e6f28858499e2e"><div class="ttname"><a href="classMagick_1_1Blob.html#a320f999fa1ed7e9ee0e6f28858499e2e">Magick::Blob::Allocator</a></div><div class="ttdeci">Allocator</div><div class="ttdef"><b>Definition:</b> <a href="Blob_8h_source.html#l00024">Blob.h:24</a></div></div> 67<div class="ttc" id="namespaceMagick_html"><div class="ttname"><a href="namespaceMagick.html">Magick</a></div><div class="ttdef"><b>Definition:</b> <a href="Blob_8h_source.html#l00015">Blob.h:15</a></div></div> 68</div><!-- fragment --></div><!-- contents --> 69</div><!-- doc-content --> 70<!-- start footer part --> 71<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> 72 <ul> 73 <li class="navelem"><a class="el" href="https://imagemagick.org/api/Magick++/dir_43e0a1f539e00dcfa1a6bc4d4fee4fc2.html">home</a></li><li class="navelem"><a class="el" href="https://imagemagick.org/api/Magick++/dir_68918867e77b0a45f29c43673f2273f8.html">cristy</a></li><li class="navelem"><a class="el" href="https://imagemagick.org/api/Magick++/dir_0664224c5e489c82e6416cddc46e1af0.html">ImageMagick-7</a></li><li class="navelem"><a class="el" href="https://imagemagick.org/api/Magick++/dir_436bc20d1ebf054c4eca7a72174ce42e.html">Magick++</a></li><li class="navelem"><a class="el" href="https://imagemagick.org/api/Magick++/dir_94b620f9ceea3d56d5ade00d9eab2203.html">lib</a></li><li class="navelem"><a class="el" href="https://imagemagick.org/api/Magick++/dir_106943ebd3829a5b74c083ee2c0647d8.html">Magick++</a></li><li class="navelem"><a class="el" href="Blob_8h.html">Blob.h</a></li> 74 <li class="footer">Generated by 75 <a href="http://www.doxygen.org/index.html"> 76 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li> 77 </ul> 78</div> 79</body> 80</html> 81
