net/ftp/ftp_directory_listing_parser.h

// Copyright (c) 2010 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef NET_FTP_FTP_DIRECTORY_LISTING_PARSER_H_
#define NET_FTP_FTP_DIRECTORY_LISTING_PARSER_H_
#pragma once

#include "base/basictypes.h"
#include "base/string16.h"
#include "base/time.h"
#include "net/ftp/ftp_server_type_histograms.h"

namespace net {

struct FtpDirectoryListingEntry {
  enum Type {
    FILE,
    DIRECTORY,
    SYMLINK,
  };

  Type type;
  string16 name;
  int64 size;  // File size, in bytes. -1 if not applicable.

  // Last modified time, in local time zone.
  base::Time last_modified;
};

class FtpDirectoryListingParser {
 public:
  virtual ~FtpDirectoryListingParser();

  virtual FtpServerType GetServerType() const = 0;

  // Adds |line| to the internal parsing buffer. Returns true on success.
  virtual bool ConsumeLine(const string16& line) = 0;

  // Called after all input has been consumed. Returns true if the parser
  // recognizes all received data as a valid listing.
  virtual bool OnEndOfInput() = 0;

  // Returns true if there is at least one FtpDirectoryListingEntry available.
  virtual bool EntryAvailable() const = 0;

  // Returns the next entry. It is an error to call this function unless
  // EntryAvailable returns true.
  virtual FtpDirectoryListingEntry PopEntry() = 0;
};

}  // namespace net

#endif  // NET_FTP_FTP_DIRECTORY_LISTING_PARSER_H_