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 #ifndef __com_sun_star_util_Endianness_idl__
  20 #define __com_sun_star_util_Endianness_idl__
  21
  22 module com { module sun { module star { module util {
  23
  24 /** These constants describe the endianness of data structures.<p>
  25
  26     The endianness specifies the order in which the bytes of larger
  27     types are laid out in memory.<p>
  28
  29     @since OOo 2.0
  30  */
  31 constants Endianness
  32 {
  33     /** Little endian.<p>
  34
  35         The values are stored in little endian format, i.e. the bytes
  36         of the long word 0xAABBCCDD are laid out like 0xDD, 0xCC,
  37         0xBB, 0xAA in memory. That is, data of arbitrary machine word
  38         lengths always starts with the least significant byte, and
  39         ends with the most significant one.<p>
  40      */
  41     const byte  LITTLE=0;
  42
  43     /** Big endian.<p>
  44
  45         The values are stored in big endian format, i.e. the bytes of
  46         the long word 0xAABBCCDD are laid out like 0xAA, 0xBB, 0xCC,
  47         0xDD in memory. That is, data of arbitrary machine word
  48         lengths always start with the most significant byte, and ends
  49         with the least significant one.<p>
  50      */
  51     const byte BIG=1;
  52 };
  53
  54 }; }; }; };
  55
  56 #endif
  57
  58 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */