chrome/browser/safe_browsing/chunk_range.h

   1 // Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4 //
   5 // Class for parsing lists of integers into ranges.
   6 //
   7 // The anti-phishing and anti-malware protocol sends ASCII strings of numbers
   8 // and ranges of numbers corresponding to chunks of whitelists and blacklists.
   9 // Clients of this protocol need to be able to convert back and forth between
  10 // this representation, and individual integer chunk numbers. The ChunkRange
  11 // class is a simple and compact mechanism for storing a continuous list of
  12 // chunk numbers.
  13
  14 #ifndef CHROME_BROWSER_SAFE_BROWSING_CHUNK_RANGE_H_
  15 #define CHROME_BROWSER_SAFE_BROWSING_CHUNK_RANGE_H_
  16
  17 #include <string>
  18 #include <vector>
  19
  20 // ChunkRange ------------------------------------------------------------------
  21 // Each ChunkRange represents a continuous range of chunk numbers [start, stop].
  22
  23 class ChunkRange {
  24  public:
  25   explicit ChunkRange(int start);
  26   ChunkRange(int start, int stop);
  27   ChunkRange(const ChunkRange& rhs);
  28
  29   inline int start() const { return start_; }
  30   inline int stop() const { return stop_; }
  31
  32   bool operator==(const ChunkRange& rhs) const {
  33     return start_ == rhs.start() && stop_ == rhs.stop();
  34   }
  35
  36  private:
  37   int start_;
  38   int stop_;
  39 };
  40
  41
  42 // Helper functions ------------------------------------------------------------
  43
  44 // Convert a set of ranges into individual chunk numbers.
  45 void RangesToChunks(const std::vector<ChunkRange>& ranges,
  46                     std::vector<int>* chunks);
  47
  48 // Returns 'true' if the string was successfully converted to ChunkRanges,
  49 // 'false' if the input was malformed.
  50 // The string must be in the form: "1-100,398,415,1138-2001,2019".
  51 bool StringToRanges(const std::string& input,
  52                     std::vector<ChunkRange>* ranges);
  53
  54 // Convenience for going from a list of chunks to a string in protocol
  55 // format.
  56 void ChunksToRangeString(const std::vector<int>& chunks, std::string* result);
  57
  58 // Tests if a chunk number is contained a sorted vector of ChunkRanges.
  59 bool IsChunkInRange(int chunk_number, const std::vector<ChunkRange>& ranges);
  60
  61 #endif  // CHROME_BROWSER_SAFE_BROWSING_CHUNK_RANGE_H_