offapi/com/sun/star/util/Endianness.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 module com { module sun { module star { module util {
  21
  22 /** These constants describe the endianness of data structures.<p>
  23
  24     The endianness specifies the order in which the bytes of larger
  25     types are laid out in memory.<p>
  26
  27     @since OOo 2.0
  28  */
  29 constants Endianness
  30 {
  31     /** Little endian.<p>
  32
  33         The values are stored in little endian format, i.e. the bytes
  34         of the long word 0xAABBCCDD are laid out like 0xDD, 0xCC,
  35         0xBB, 0xAA in memory. That is, data of arbitrary machine word
  36         lengths always starts with the least significant byte, and
  37         ends with the most significant one.<p>
  38      */
  39     const byte  LITTLE=0;
  40
  41     /** Big endian.<p>
  42
  43         The values are stored in big endian format, i.e. the bytes of
  44         the long word 0xAABBCCDD are laid out like 0xAA, 0xBB, 0xCC,
  45         0xDD in memory. That is, data of arbitrary machine word
  46         lengths always start with the most significant byte, and ends
  47         with the least significant one.<p>
  48      */
  49     const byte BIG=1;
  50 };
  51
  52 }; }; }; };
  53
  54 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */