gecko/image/decoders/nsIconDecoder.h
Nicholas Nethercote f671723176 Bug 1210291 - Streamline StreamingLexer's handling of terminal states. r=seth.
This patch introduces TerminalState and changes LexerTransition::mNextState to
be a Variant<State, TerminalState>. This means that SUCCESS and FAILURE no
longer need to be part of State.

Some things to note:

- This simplifies the handling of Lex()'s return value, which is nice.

- The patch splits Terminate() into TerminateSuccess() and TerminateFailure().

- |const State& aNextState| wouldn't work for the first arg to
  LexerTransition's ctor due to errors in Variant construction that I didn't
  understand. I had to change it to |State aNextState|.
2015-10-28 01:30:20 -07:00

72 lines
2.2 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_image_decoders_nsIconDecoder_h
#define mozilla_image_decoders_nsIconDecoder_h
#include "Decoder.h"
#include "StreamingLexer.h"
#include "nsCOMPtr.h"
namespace mozilla {
namespace image {
class RasterImage;
////////////////////////////////////////////////////////////////////////////////
// The icon decoder is a decoder specifically tailored for loading icons
// from the OS. We've defined our own little format to represent these icons
// and this decoder takes that format and converts it into 24-bit RGB with
// alpha channel support. It was modeled a bit off the PPM decoder.
//
// Assumptions about the decoder:
// (1) We receive ALL of the data from the icon channel in one OnDataAvailable
// call. We don't support multiple ODA calls yet.
// (2) the format of the incoming data is as follows:
// The first two bytes contain the width and the height of the icon.
// The remaining bytes contain the icon data, 4 bytes per pixel, in
// ARGB order (platform endianness, A in highest bits, B in lowest
// bits), row-primary, top-to-bottom, left-to-right, with
// premultiplied alpha.
//
//
////////////////////////////////////////////////////////////////////////////////
class nsIconDecoder : public Decoder
{
public:
virtual ~nsIconDecoder();
virtual void WriteInternal(const char* aBuffer, uint32_t aCount) override;
private:
friend class DecoderFactory;
// Decoders should only be instantiated via DecoderFactory.
explicit nsIconDecoder(RasterImage* aImage);
enum class State {
HEADER,
ROW_OF_PIXELS,
FINISH
};
LexerTransition<State> ReadHeader(const char* aData);
LexerTransition<State> ReadRowOfPixels(const char* aData, size_t aLength);
LexerTransition<State> Finish();
StreamingLexer<State> mLexer;
uint8_t mWidth;
uint8_t mHeight;
uint32_t mBytesPerRow;
uint32_t mBytesTotal;
uint32_t mCurrentRow;
};
} // namespace image
} // namespace mozilla
#endif // mozilla_image_decoders_nsIconDecoder_h