Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Delta Between Two Patch Sets: include/AdblockPlus/FilterEngine.h

Issue 5728380594946048: Issue 116 - Document the libadblockplus API (Closed)
Left Patch Set: Remembered that AppInfo is used for more than update checks Created Sept. 2, 2014, 6:23 a.m.
Right Patch Set: Write libadblockplus in lower case consistently Created Sept. 2, 2014, 2:18 p.m.
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
Left: Side by side diff | Download
Right: Side by side diff | Download
« no previous file with change/comment | « include/AdblockPlus/FileSystem.h ('k') | include/AdblockPlus/JsEngine.h » ('j') | no next file with change/comment »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
LEFTRIGHT
1 /* 1 /*
2 * This file is part of Adblock Plus <http://adblockplus.org/>, 2 * This file is part of Adblock Plus <http://adblockplus.org/>,
3 * Copyright (C) 2006-2014 Eyeo GmbH 3 * Copyright (C) 2006-2014 Eyeo GmbH
4 * 4 *
5 * Adblock Plus is free software: you can redistribute it and/or modify 5 * Adblock Plus is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 3 as 6 * it under the terms of the GNU General Public License version 3 as
7 * published by the Free Software Foundation. 7 * published by the Free Software Foundation.
8 * 8 *
9 * Adblock Plus is distributed in the hope that it will be useful, 9 * Adblock Plus is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
(...skipping 90 matching lines...) Expand 10 before | Expand all | Expand 10 after
101 */ 101 */
102 void RemoveFromList(); 102 void RemoveFromList();
103 103
104 /** 104 /**
105 * Updates this subscription, i.e.\ retrieves the current filters from the 105 * Updates this subscription, i.e.\ retrieves the current filters from the
106 * subscription URL. 106 * subscription URL.
107 */ 107 */
108 void UpdateFilters(); 108 void UpdateFilters();
109 109
110 /** 110 /**
111 * Checks if subscriptions are currently being updated. 111 * Checks if the subscription is currently being updated.
112 * @return `true` if subscriptions are currently being updated. 112 * @return `true` if the subscription is currently being updated.
Wladimir Palant 2014/09/02 13:11:21 This is misleading now - the mistake was actually
Felix Dahlke 2014/09/02 13:24:05 Double ouch. Done.
113 */ 113 */
114 bool IsUpdating(); 114 bool IsUpdating();
115 115
116 bool operator==(const Subscription& subscription) const; 116 bool operator==(const Subscription& subscription) const;
117 117
118 /** 118 /**
119 * Creates a wrapper for an existing JavaScript subscription object. 119 * Creates a wrapper for an existing JavaScript subscription object.
120 * Normally you shouldn't call this directly, but use 120 * Normally you shouldn't call this directly, but use
121 * FilterEngine::GetSubscription() instead. 121 * FilterEngine::GetSubscription() instead.
122 * @param value JavaScript subscription object. 122 * @param value JavaScript subscription object.
123 */ 123 */
124 Subscription(JsValuePtr value); 124 Subscription(JsValuePtr value);
125 }; 125 };
126 126
127 /** 127 /**
128 * Shared smart pointer to a `Filter` instance. 128 * Shared smart pointer to a `Filter` instance.
129 */ 129 */
130 typedef std::tr1::shared_ptr<Filter> FilterPtr; 130 typedef std::tr1::shared_ptr<Filter> FilterPtr;
131 131
132 /** 132 /**
133 * Shared smart pointer to a `Subscription` instance. 133 * Shared smart pointer to a `Subscription` instance.
134 */ 134 */
135 typedef std::tr1::shared_ptr<Subscription> SubscriptionPtr; 135 typedef std::tr1::shared_ptr<Subscription> SubscriptionPtr;
136 136
137 /** 137 /**
138 * Main component of Libadblockplus. 138 * Main component of libadblockplus.
139 * It handles: 139 * It handles:
140 * - Filter management and matching. 140 * - Filter management and matching.
141 * - Subscription management and synchronization. 141 * - Subscription management and synchronization.
142 * - Update checks for the application. 142 * - Update checks for the application.
143 */ 143 */
144 class FilterEngine 144 class FilterEngine
145 { 145 {
146 public: 146 public:
147 /** 147 /**
148 * Callback type invoked when an update is available. 148 * Callback type invoked when an update is available.
(...skipping 191 matching lines...) Expand 10 before | Expand all | Expand 10 after
340 void InitDone(JsValueList& params); 340 void InitDone(JsValueList& params);
341 FilterPtr CheckFilterMatch(const std::string& url, 341 FilterPtr CheckFilterMatch(const std::string& url,
342 const std::string& contentType, 342 const std::string& contentType,
343 const std::string& documentUrl) const; 343 const std::string& documentUrl) const;
344 void UpdateCheckDone(const std::string& eventName, UpdaterCallback callback, JsValueList& params); 344 void UpdateCheckDone(const std::string& eventName, UpdaterCallback callback, JsValueList& params);
345 void FilterChanged(FilterChangeCallback callback, JsValueList& params); 345 void FilterChanged(FilterChangeCallback callback, JsValueList& params);
346 }; 346 };
347 } 347 }
348 348
349 #endif 349 #endif
LEFTRIGHT

Powered by Google App Engine
This is Rietveld