text
stringlengths 1
22.8M
|
|---|
A dream board or vision board is a collage of images, pictures, and affirmations of one's dreams and desires, designed to serve as a source of inspiration and motivation. The usefulness of vision boards has been endorsed by celebrities such as Oprah Winfrey, Steve Harvey, and John Pierre. The author Octavia E. Butler wrote prose affirmations into her notebook, in what is seen by some as a prototype of the modern vision board. However, there is some evidence that vision boards may be counterproductive, since continually fantasizing about success can lead to taking fewer actions to realizing it. Thus, an "action board" is sometimes viewed as a better alternative or accompaniment.
References
New Age
|
```objective-c
// -*- C++ -*-
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the terms
// Foundation; either version 3, or (at your option) any later
// version.
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Under Section 7 of GPL version 3, you are granted additional
// permissions described in the GCC Runtime Library Exception, version
// 3.1, as published by the Free Software Foundation.
// a copy of the GCC Runtime Library Exception along with this program;
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <path_to_url
/**
* @file parallel/set_operations.h
* @brief Parallel implementations of set operations for random-access
* iterators.
* This file is a GNU parallel extension to the Standard C++ Library.
*/
// Written by Marius Elvert and Felix Bondarenko.
#ifndef _GLIBCXX_PARALLEL_SET_OPERATIONS_H
#define _GLIBCXX_PARALLEL_SET_OPERATIONS_H 1
#include <omp.h>
#include <parallel/settings.h>
#include <parallel/multiseq_selection.h>
namespace __gnu_parallel
{
template<typename _IIter, typename _OutputIterator>
_OutputIterator
__copy_tail(std::pair<_IIter, _IIter> __b,
std::pair<_IIter, _IIter> __e, _OutputIterator __r)
{
if (__b.first != __e.first)
{
do
{
*__r++ = *__b.first++;
}
while (__b.first != __e.first);
}
else
{
while (__b.second != __e.second)
*__r++ = *__b.second++;
}
return __r;
}
template<typename _IIter,
typename _OutputIterator,
typename _Compare>
struct __symmetric_difference_func
{
typedef std::iterator_traits<_IIter> _TraitsType;
typedef typename _TraitsType::difference_type _DifferenceType;
typedef typename std::pair<_IIter, _IIter> _IteratorPair;
__symmetric_difference_func(_Compare __comp) : _M_comp(__comp) {}
_Compare _M_comp;
_OutputIterator
_M_invoke(_IIter __a, _IIter __b, _IIter __c, _IIter __d,
_OutputIterator __r) const
{
while (__a != __b && __c != __d)
{
if (_M_comp(*__a, *__c))
{
*__r = *__a;
++__a;
++__r;
}
else if (_M_comp(*__c, *__a))
{
*__r = *__c;
++__c;
++__r;
}
else
{
++__a;
++__c;
}
}
return std::copy(__c, __d, std::copy(__a, __b, __r));
}
_DifferenceType
__count(_IIter __a, _IIter __b, _IIter __c, _IIter __d) const
{
_DifferenceType __counter = 0;
while (__a != __b && __c != __d)
{
if (_M_comp(*__a, *__c))
{
++__a;
++__counter;
}
else if (_M_comp(*__c, *__a))
{
++__c;
++__counter;
}
else
{
++__a;
++__c;
}
}
return __counter + (__b - __a) + (__d - __c);
}
_OutputIterator
__first_empty(_IIter __c, _IIter __d, _OutputIterator __out) const
{ return std::copy(__c, __d, __out); }
_OutputIterator
__second_empty(_IIter __a, _IIter __b, _OutputIterator __out) const
{ return std::copy(__a, __b, __out); }
};
template<typename _IIter,
typename _OutputIterator,
typename _Compare>
struct __difference_func
{
typedef std::iterator_traits<_IIter> _TraitsType;
typedef typename _TraitsType::difference_type _DifferenceType;
typedef typename std::pair<_IIter, _IIter> _IteratorPair;
__difference_func(_Compare __comp) : _M_comp(__comp) {}
_Compare _M_comp;
_OutputIterator
_M_invoke(_IIter __a, _IIter __b, _IIter __c, _IIter __d,
_OutputIterator __r) const
{
while (__a != __b && __c != __d)
{
if (_M_comp(*__a, *__c))
{
*__r = *__a;
++__a;
++__r;
}
else if (_M_comp(*__c, *__a))
{ ++__c; }
else
{
++__a;
++__c;
}
}
return std::copy(__a, __b, __r);
}
_DifferenceType
__count(_IIter __a, _IIter __b,
_IIter __c, _IIter __d) const
{
_DifferenceType __counter = 0;
while (__a != __b && __c != __d)
{
if (_M_comp(*__a, *__c))
{
++__a;
++__counter;
}
else if (_M_comp(*__c, *__a))
{ ++__c; }
else
{ ++__a; ++__c; }
}
return __counter + (__b - __a);
}
_OutputIterator
__first_empty(_IIter, _IIter, _OutputIterator __out) const
{ return __out; }
_OutputIterator
__second_empty(_IIter __a, _IIter __b, _OutputIterator __out) const
{ return std::copy(__a, __b, __out); }
};
template<typename _IIter,
typename _OutputIterator,
typename _Compare>
struct __intersection_func
{
typedef std::iterator_traits<_IIter> _TraitsType;
typedef typename _TraitsType::difference_type _DifferenceType;
typedef typename std::pair<_IIter, _IIter> _IteratorPair;
__intersection_func(_Compare __comp) : _M_comp(__comp) {}
_Compare _M_comp;
_OutputIterator
_M_invoke(_IIter __a, _IIter __b, _IIter __c, _IIter __d,
_OutputIterator __r) const
{
while (__a != __b && __c != __d)
{
if (_M_comp(*__a, *__c))
{ ++__a; }
else if (_M_comp(*__c, *__a))
{ ++__c; }
else
{
*__r = *__a;
++__a;
++__c;
++__r;
}
}
return __r;
}
_DifferenceType
__count(_IIter __a, _IIter __b, _IIter __c, _IIter __d) const
{
_DifferenceType __counter = 0;
while (__a != __b && __c != __d)
{
if (_M_comp(*__a, *__c))
{ ++__a; }
else if (_M_comp(*__c, *__a))
{ ++__c; }
else
{
++__a;
++__c;
++__counter;
}
}
return __counter;
}
_OutputIterator
__first_empty(_IIter, _IIter, _OutputIterator __out) const
{ return __out; }
_OutputIterator
__second_empty(_IIter, _IIter, _OutputIterator __out) const
{ return __out; }
};
template<class _IIter, class _OutputIterator, class _Compare>
struct __union_func
{
typedef typename std::iterator_traits<_IIter>::difference_type
_DifferenceType;
__union_func(_Compare __comp) : _M_comp(__comp) {}
_Compare _M_comp;
_OutputIterator
_M_invoke(_IIter __a, const _IIter __b, _IIter __c,
const _IIter __d, _OutputIterator __r) const
{
while (__a != __b && __c != __d)
{
if (_M_comp(*__a, *__c))
{
*__r = *__a;
++__a;
}
else if (_M_comp(*__c, *__a))
{
*__r = *__c;
++__c;
}
else
{
*__r = *__a;
++__a;
++__c;
}
++__r;
}
return std::copy(__c, __d, std::copy(__a, __b, __r));
}
_DifferenceType
__count(_IIter __a, _IIter __b, _IIter __c, _IIter __d) const
{
_DifferenceType __counter = 0;
while (__a != __b && __c != __d)
{
if (_M_comp(*__a, *__c))
{ ++__a; }
else if (_M_comp(*__c, *__a))
{ ++__c; }
else
{
++__a;
++__c;
}
++__counter;
}
__counter += (__b - __a);
__counter += (__d - __c);
return __counter;
}
_OutputIterator
__first_empty(_IIter __c, _IIter __d, _OutputIterator __out) const
{ return std::copy(__c, __d, __out); }
_OutputIterator
__second_empty(_IIter __a, _IIter __b, _OutputIterator __out) const
{ return std::copy(__a, __b, __out); }
};
template<typename _IIter,
typename _OutputIterator,
typename _Operation>
_OutputIterator
__parallel_set_operation(_IIter __begin1, _IIter __end1,
_IIter __begin2, _IIter __end2,
_OutputIterator __result, _Operation __op)
{
_GLIBCXX_CALL((__end1 - __begin1) + (__end2 - __begin2))
typedef std::iterator_traits<_IIter> _TraitsType;
typedef typename _TraitsType::difference_type _DifferenceType;
typedef typename std::pair<_IIter, _IIter> _IteratorPair;
if (__begin1 == __end1)
return __op.__first_empty(__begin2, __end2, __result);
if (__begin2 == __end2)
return __op.__second_empty(__begin1, __end1, __result);
const _DifferenceType __size = (__end1 - __begin1) + (__end2 - __begin2);
const _IteratorPair __sequence[2] = { std::make_pair(__begin1, __end1),
std::make_pair(__begin2, __end2) };
_OutputIterator __return_value = __result;
_DifferenceType *__borders;
_IteratorPair *__block_begins;
_DifferenceType* __lengths;
_ThreadIndex __num_threads =
std::min<_DifferenceType>(__get_max_threads(),
std::min(__end1 - __begin1, __end2 - __begin2));
# pragma omp parallel num_threads(__num_threads)
{
# pragma omp single
{
__num_threads = omp_get_num_threads();
__borders = new _DifferenceType[__num_threads + 2];
__equally_split(__size, __num_threads + 1, __borders);
__block_begins = new _IteratorPair[__num_threads + 1];
// Very __start.
__block_begins[0] = std::make_pair(__begin1, __begin2);
__lengths = new _DifferenceType[__num_threads];
} //single
_ThreadIndex __iam = omp_get_thread_num();
// _Result from multiseq_partition.
_IIter __offset[2];
const _DifferenceType __rank = __borders[__iam + 1];
multiseq_partition(__sequence, __sequence + 2,
__rank, __offset, __op._M_comp);
// allowed to read?
// together
// *(__offset[ 0 ] - 1) == *__offset[ 1 ]
if (__offset[ 0 ] != __begin1 && __offset[1] != __end2
&& !__op._M_comp(*(__offset[0] - 1), *__offset[1])
&& !__op._M_comp(*__offset[1], *(__offset[0] - 1)))
{
// Avoid split between globally equal elements: move one to
// front in first sequence.
--__offset[0];
}
_IteratorPair __block_end = __block_begins[__iam + 1] =
_IteratorPair(__offset[0], __offset[1]);
// Make sure all threads have their block_begin result written out.
# pragma omp barrier
_IteratorPair __block_begin = __block_begins[__iam];
// Begin working for the first block, while the others except
// the last start to count.
if (__iam == 0)
{
// The first thread can copy already.
__lengths[ __iam ] =
__op._M_invoke(__block_begin.first, __block_end.first,
__block_begin.second, __block_end.second,
__result) - __result;
}
else
{
__lengths[ __iam ] =
__op.__count(__block_begin.first, __block_end.first,
__block_begin.second, __block_end.second);
}
// Make sure everyone wrote their lengths.
# pragma omp barrier
_OutputIterator __r = __result;
if (__iam == 0)
{
// Do the last block.
for (_ThreadIndex __i = 0; __i < __num_threads; ++__i)
__r += __lengths[__i];
__block_begin = __block_begins[__num_threads];
// Return the result iterator of the last block.
__return_value =
__op._M_invoke(__block_begin.first, __end1,
__block_begin.second, __end2, __r);
}
else
{
for (_ThreadIndex __i = 0; __i < __iam; ++__i)
__r += __lengths[ __i ];
// Reset begins for copy pass.
__op._M_invoke(__block_begin.first, __block_end.first,
__block_begin.second, __block_end.second, __r);
}
}
return __return_value;
}
template<typename _IIter,
typename _OutputIterator,
typename _Compare>
inline _OutputIterator
__parallel_set_union(_IIter __begin1, _IIter __end1,
_IIter __begin2, _IIter __end2,
_OutputIterator __result, _Compare __comp)
{
return __parallel_set_operation(__begin1, __end1, __begin2, __end2,
__result,
__union_func< _IIter, _OutputIterator,
_Compare>(__comp));
}
template<typename _IIter,
typename _OutputIterator,
typename _Compare>
inline _OutputIterator
__parallel_set_intersection(_IIter __begin1, _IIter __end1,
_IIter __begin2, _IIter __end2,
_OutputIterator __result, _Compare __comp)
{
return __parallel_set_operation(__begin1, __end1, __begin2, __end2,
__result,
__intersection_func<_IIter,
_OutputIterator, _Compare>(__comp));
}
template<typename _IIter,
typename _OutputIterator,
typename _Compare>
inline _OutputIterator
__parallel_set_difference(_IIter __begin1, _IIter __end1,
_IIter __begin2, _IIter __end2,
_OutputIterator __result, _Compare __comp)
{
return __parallel_set_operation(__begin1, __end1, __begin2, __end2,
__result,
__difference_func<_IIter,
_OutputIterator, _Compare>(__comp));
}
template<typename _IIter,
typename _OutputIterator,
typename _Compare>
inline _OutputIterator
__parallel_set_symmetric_difference(_IIter __begin1, _IIter __end1,
_IIter __begin2, _IIter __end2,
_OutputIterator __result,
_Compare __comp)
{
return __parallel_set_operation(__begin1, __end1, __begin2, __end2,
__result,
__symmetric_difference_func<_IIter,
_OutputIterator, _Compare>(__comp));
}
}
#endif /* _GLIBCXX_PARALLEL_SET_OPERATIONS_H */
```
|
```kotlin
package mega.privacy.android.domain.entity.camerauploads
/**
* Restart mode after the stop of the Camera Uploads worker
*/
enum class CameraUploadsRestartMode {
/**
* Reschedule the Camera Uploads Worker to a later time
*/
Reschedule,
/**
* Restart immediately the Camera Uploads Worker after it has been stopped
*/
RestartImmediately,
/**
* Stop the Camera Uploads Worker without disabling the feature
*/
Stop,
/**
* Stop the Camera Uploads Worker and disable the feature
*/
StopAndDisable,
}
```
|
is a railway station in Midori-ku, Nagoya, Japan, operated by Central Japan Railway Company (JR Tōkai).
Lines
Ōdaka Station is served by the Tōkaidō Main Line, and is located 353.6 kilometers from the starting point of the line at Tokyo Station.
Station layout
The station has one elevated island platform with the station building underneath. The station building has automated ticket machines, TOICA automated turnstiles and a staffed ticket office.
Platforms
Adjacent stations
|-
!colspan=5|Central Japan Railway Company
Station history
Ōdaka Station was opened on March 1, 1886 with the completion of the Japanese Government Railway (JGR) line connecting Taketoyo Station and Atsuta Station. This line was named the Tōkaidō Line in 1895 and the Tōkaidō Main Line in 1909. A new station building was completed in March 1935. The JGR became the JNR after World War II. All freight operations were discontinued from August 1961. A new station building was completed in May 1962, but was relocated to its present location and rebuilt in 1978. With the privatization and dissolution of the JNR on April 1, 1987, the station came under the control of the Central Japan Railway Company.
Station numbering was introduced to the section of the Tōkaidō Line operated JR Central in March 2018; Ōdaka Station was assigned station number CA63.
Passenger statistics
In fiscal 2017, the station was used by an average of 4,323 passengers daily
Surrounding area
site of the Battle of Okehazama
Midori-ku Ward Office
See also
List of Railway Stations in Japan
References
Yoshikawa, Fumio. Tokaido-sen 130-nen no ayumi. Grand-Prix Publishing (2002) .
External links
Official home page
Railway stations in Japan opened in 1886
Tōkaidō Main Line
Stations of Central Japan Railway Company
Railway stations in Nagoya
Railway stations in Aichi Prefecture
|
```c++
// 2016 and later: Unicode, Inc. and others.
/*
*******************************************************************************
*
* Corporation and others. All Rights Reserved.
*
*******************************************************************************
* file name: ucmstate.c
* encoding: UTF-8
* tab size: 8 (not used)
* indentation:4
*
* created on: 2003oct09
* created by: Markus W. Scherer
*
* This file handles ICU .ucm file state information as part of the ucm module.
* Most of this code used to be in makeconv.c.
*/
#include "unicode/utypes.h"
#include "cstring.h"
#include "cmemory.h"
#include "uarrsort.h"
#include "ucnvmbcs.h"
#include "ucnv_ext.h"
#include "uparse.h"
#include "ucm.h"
#include <stdio.h>
#if !UCONFIG_NO_CONVERSION
/* MBCS state handling ------------------------------------------------------ */
/*
* state table row grammar (ebnf-style):
* (whitespace is allowed between all tokens)
*
* row=[[firstentry ','] entry (',' entry)*]
* firstentry="initial" | "surrogates"
* (initial state (default for state 0), output is all surrogate pairs)
* entry=range [':' nextstate] ['.' action]
* range=number ['-' number]
* nextstate=number
* (0..7f)
* action='u' | 's' | 'p' | 'i'
* (unassigned, state change only, surrogate pair, illegal)
* number=(1- or 2-digit hexadecimal number)
*/
static const char *
parseState(const char *s, int32_t state[256], uint32_t *pFlags) {
const char *t;
uint32_t start, end, i;
int32_t entry;
/* initialize the state: all illegal with U+ffff */
for(i=0; i<256; ++i) {
state[i]=MBCS_ENTRY_FINAL(0, MBCS_STATE_ILLEGAL, 0xffff);
}
/* skip leading white space */
s=u_skipWhitespace(s);
/* is there an "initial" or "surrogates" directive? */
if(uprv_strncmp("initial", s, 7)==0) {
*pFlags=MBCS_STATE_FLAG_DIRECT;
s=u_skipWhitespace(s+7);
if(*s++!=',') {
return s-1;
}
} else if(*pFlags==0 && uprv_strncmp("surrogates", s, 10)==0) {
*pFlags=MBCS_STATE_FLAG_SURROGATES;
s=u_skipWhitespace(s+10);
if(*s++!=',') {
return s-1;
}
} else if(*s==0) {
/* empty state row: all-illegal */
return NULL;
}
for(;;) {
/* read an entry, the start of the range first */
s=u_skipWhitespace(s);
start=uprv_strtoul(s, (char **)&t, 16);
if(s==t || 0xff<start) {
return s;
}
s=u_skipWhitespace(t);
/* read the end of the range if there is one */
if(*s=='-') {
s=u_skipWhitespace(s+1);
end=uprv_strtoul(s, (char **)&t, 16);
if(s==t || end<start || 0xff<end) {
return s;
}
s=u_skipWhitespace(t);
} else {
end=start;
}
/* determine the state entrys for this range */
if(*s!=':' && *s!='.') {
/* the default is: final state with valid entries */
entry=MBCS_ENTRY_FINAL(0, MBCS_STATE_VALID_16, 0);
} else {
entry=MBCS_ENTRY_TRANSITION(0, 0);
if(*s==':') {
/* get the next state, default to 0 */
s=u_skipWhitespace(s+1);
i=uprv_strtoul(s, (char **)&t, 16);
if(s!=t) {
if(0x7f<i) {
return s;
}
s=u_skipWhitespace(t);
entry=MBCS_ENTRY_SET_STATE(entry, i);
}
}
/* get the state action, default to valid */
if(*s=='.') {
/* this is a final state */
entry=MBCS_ENTRY_SET_FINAL(entry);
s=u_skipWhitespace(s+1);
if(*s=='u') {
/* unassigned set U+fffe */
entry=MBCS_ENTRY_FINAL_SET_ACTION_VALUE(entry, MBCS_STATE_UNASSIGNED, 0xfffe);
s=u_skipWhitespace(s+1);
} else if(*s=='p') {
if(*pFlags!=MBCS_STATE_FLAG_DIRECT) {
entry=MBCS_ENTRY_FINAL_SET_ACTION(entry, MBCS_STATE_VALID_16_PAIR);
} else {
entry=MBCS_ENTRY_FINAL_SET_ACTION(entry, MBCS_STATE_VALID_16);
}
s=u_skipWhitespace(s+1);
} else if(*s=='s') {
entry=MBCS_ENTRY_FINAL_SET_ACTION(entry, MBCS_STATE_CHANGE_ONLY);
s=u_skipWhitespace(s+1);
} else if(*s=='i') {
/* illegal set U+ffff */
entry=MBCS_ENTRY_FINAL_SET_ACTION_VALUE(entry, MBCS_STATE_ILLEGAL, 0xffff);
s=u_skipWhitespace(s+1);
} else {
/* default to valid */
entry=MBCS_ENTRY_FINAL_SET_ACTION(entry, MBCS_STATE_VALID_16);
}
} else {
/* this is an intermediate state, nothing to do */
}
}
/* adjust "final valid" states according to the state flags */
if(MBCS_ENTRY_FINAL_ACTION(entry)==MBCS_STATE_VALID_16) {
switch(*pFlags) {
case 0:
/* no adjustment */
break;
case MBCS_STATE_FLAG_DIRECT:
/* set the valid-direct code point to "unassigned"==0xfffe */
entry=MBCS_ENTRY_FINAL_SET_ACTION_VALUE(entry, MBCS_STATE_VALID_DIRECT_16, 0xfffe);
break;
case MBCS_STATE_FLAG_SURROGATES:
entry=MBCS_ENTRY_FINAL_SET_ACTION_VALUE(entry, MBCS_STATE_VALID_16_PAIR, 0);
break;
default:
break;
}
}
/* set this entry for the range */
for(i=start; i<=end; ++i) {
state[i]=entry;
}
if(*s==',') {
++s;
} else {
return *s==0 ? NULL : s;
}
}
}
U_CAPI void U_EXPORT2
ucm_addState(UCMStates *states, const char *s) {
const char *error;
if(states->countStates==MBCS_MAX_STATE_COUNT) {
fprintf(stderr, "ucm error: too many states (maximum %u)\n", MBCS_MAX_STATE_COUNT);
exit(U_INVALID_TABLE_FORMAT);
}
error=parseState(s, states->stateTable[states->countStates],
&states->stateFlags[states->countStates]);
if(error!=NULL) {
fprintf(stderr, "ucm error: parse error in state definition at '%s'\n", error);
exit(U_INVALID_TABLE_FORMAT);
}
++states->countStates;
}
U_CAPI UBool U_EXPORT2
ucm_parseHeaderLine(UCMFile *ucm,
char *line, char **pKey, char **pValue) {
UCMStates *states;
char *s, *end;
char c;
states=&ucm->states;
/* remove comments and trailing CR and LF and remove whitespace from the end */
for(end=line; (c=*end)!=0; ++end) {
if(c=='#' || c=='\r' || c=='\n') {
break;
}
}
while(end>line && (*(end-1)==' ' || *(end-1)=='\t')) {
--end;
}
*end=0;
/* skip leading white space and ignore empty lines */
s=(char *)u_skipWhitespace(line);
if(*s==0) {
return TRUE;
}
/* stop at the beginning of the mapping section */
if(uprv_memcmp(s, "CHARMAP", 7)==0) {
return FALSE;
}
/* get the key name, bracketed in <> */
if(*s!='<') {
fprintf(stderr, "ucm error: no header field <key> in line \"%s\"\n", line);
exit(U_INVALID_TABLE_FORMAT);
}
*pKey=++s;
while(*s!='>') {
if(*s==0) {
fprintf(stderr, "ucm error: incomplete header field <key> in line \"%s\"\n", line);
exit(U_INVALID_TABLE_FORMAT);
}
++s;
}
*s=0;
/* get the value string, possibly quoted */
s=(char *)u_skipWhitespace(s+1);
if(*s!='"') {
*pValue=s;
} else {
/* remove the quotes */
*pValue=s+1;
if(end>*pValue && *(end-1)=='"') {
*--end=0;
}
}
/* collect the information from the header field, ignore unknown keys */
if(uprv_strcmp(*pKey, "uconv_class")==0) {
if(uprv_strcmp(*pValue, "DBCS")==0) {
states->conversionType=UCNV_DBCS;
} else if(uprv_strcmp(*pValue, "SBCS")==0) {
states->conversionType = UCNV_SBCS;
} else if(uprv_strcmp(*pValue, "MBCS")==0) {
states->conversionType = UCNV_MBCS;
} else if(uprv_strcmp(*pValue, "EBCDIC_STATEFUL")==0) {
states->conversionType = UCNV_EBCDIC_STATEFUL;
} else {
fprintf(stderr, "ucm error: unknown <uconv_class> %s\n", *pValue);
exit(U_INVALID_TABLE_FORMAT);
}
return TRUE;
} else if(uprv_strcmp(*pKey, "mb_cur_max")==0) {
c=**pValue;
if('1'<=c && c<='4' && (*pValue)[1]==0) {
states->maxCharLength=(int8_t)(c-'0');
states->outputType=(int8_t)(states->maxCharLength-1);
} else {
fprintf(stderr, "ucm error: illegal <mb_cur_max> %s\n", *pValue);
exit(U_INVALID_TABLE_FORMAT);
}
return TRUE;
} else if(uprv_strcmp(*pKey, "mb_cur_min")==0) {
c=**pValue;
if('1'<=c && c<='4' && (*pValue)[1]==0) {
states->minCharLength=(int8_t)(c-'0');
} else {
fprintf(stderr, "ucm error: illegal <mb_cur_min> %s\n", *pValue);
exit(U_INVALID_TABLE_FORMAT);
}
return TRUE;
} else if(uprv_strcmp(*pKey, "icu:state")==0) {
/* if an SBCS/DBCS/EBCDIC_STATEFUL converter has icu:state, then turn it into MBCS */
switch(states->conversionType) {
case UCNV_SBCS:
case UCNV_DBCS:
case UCNV_EBCDIC_STATEFUL:
states->conversionType=UCNV_MBCS;
break;
case UCNV_MBCS:
break;
default:
fprintf(stderr, "ucm error: <icu:state> entry for non-MBCS table or before the <uconv_class> line\n");
exit(U_INVALID_TABLE_FORMAT);
}
if(states->maxCharLength==0) {
fprintf(stderr, "ucm error: <icu:state> before the <mb_cur_max> line\n");
exit(U_INVALID_TABLE_FORMAT);
}
ucm_addState(states, *pValue);
return TRUE;
} else if(uprv_strcmp(*pKey, "icu:base")==0) {
if(**pValue==0) {
fprintf(stderr, "ucm error: <icu:base> without a base table name\n");
exit(U_INVALID_TABLE_FORMAT);
}
uprv_strcpy(ucm->baseName, *pValue);
return TRUE;
}
return FALSE;
}
/* post-processing ---------------------------------------------------------- */
static int32_t
sumUpStates(UCMStates *states) {
int32_t entry, sum, state, cell, count;
UBool allStatesReady;
/*
* Sum up the offsets for all states.
* In each final state (where there are only final entries),
* the offsets add up directly.
* In all other state table rows, for each transition entry to another state,
* the offsets sum of that state needs to be added.
* This is achieved in at most countStates iterations.
*/
allStatesReady=FALSE;
for(count=states->countStates; !allStatesReady && count>=0; --count) {
allStatesReady=TRUE;
for(state=states->countStates-1; state>=0; --state) {
if(!(states->stateFlags[state]&MBCS_STATE_FLAG_READY)) {
allStatesReady=FALSE;
sum=0;
/* at first, add up only the final delta offsets to keep them <512 */
for(cell=0; cell<256; ++cell) {
entry=states->stateTable[state][cell];
if(MBCS_ENTRY_IS_FINAL(entry)) {
switch(MBCS_ENTRY_FINAL_ACTION(entry)) {
case MBCS_STATE_VALID_16:
states->stateTable[state][cell]=MBCS_ENTRY_FINAL_SET_VALUE(entry, sum);
sum+=1;
break;
case MBCS_STATE_VALID_16_PAIR:
states->stateTable[state][cell]=MBCS_ENTRY_FINAL_SET_VALUE(entry, sum);
sum+=2;
break;
default:
/* no addition */
break;
}
}
}
/* now, add up the delta offsets for the transitional entries */
for(cell=0; cell<256; ++cell) {
entry=states->stateTable[state][cell];
if(MBCS_ENTRY_IS_TRANSITION(entry)) {
if(states->stateFlags[MBCS_ENTRY_TRANSITION_STATE(entry)]&MBCS_STATE_FLAG_READY) {
states->stateTable[state][cell]=MBCS_ENTRY_TRANSITION_SET_OFFSET(entry, sum);
sum+=states->stateOffsetSum[MBCS_ENTRY_TRANSITION_STATE(entry)];
} else {
/* that next state does not have a sum yet, we cannot finish the one for this state */
sum=-1;
break;
}
}
}
if(sum!=-1) {
states->stateOffsetSum[state]=sum;
states->stateFlags[state]|=MBCS_STATE_FLAG_READY;
}
}
}
}
if(!allStatesReady) {
fprintf(stderr, "ucm error: the state table contains loops\n");
exit(U_INVALID_TABLE_FORMAT);
}
/*
* For all "direct" (i.e., initial) states>0,
* the offsets need to be increased by the sum of
* the previous initial states.
*/
sum=states->stateOffsetSum[0];
for(state=1; state<states->countStates; ++state) {
if((states->stateFlags[state]&0xf)==MBCS_STATE_FLAG_DIRECT) {
int32_t sum2=sum;
sum+=states->stateOffsetSum[state];
for(cell=0; cell<256; ++cell) {
entry=states->stateTable[state][cell];
if(MBCS_ENTRY_IS_TRANSITION(entry)) {
states->stateTable[state][cell]=MBCS_ENTRY_TRANSITION_ADD_OFFSET(entry, sum2);
}
}
}
}
/* round up to the next even number to have the following data 32-bit-aligned */
return states->countToUCodeUnits=(sum+1)&~1;
}
U_CAPI void U_EXPORT2
ucm_processStates(UCMStates *states, UBool ignoreSISOCheck) {
int32_t entry, state, cell, count;
if(states->conversionType==UCNV_UNSUPPORTED_CONVERTER) {
fprintf(stderr, "ucm error: missing conversion type (<uconv_class>)\n");
exit(U_INVALID_TABLE_FORMAT);
}
if(states->countStates==0) {
switch(states->conversionType) {
case UCNV_SBCS:
/* SBCS: use MBCS data structure with a default state table */
if(states->maxCharLength!=1) {
fprintf(stderr, "error: SBCS codepage with max B/char!=1\n");
exit(U_INVALID_TABLE_FORMAT);
}
states->conversionType=UCNV_MBCS;
ucm_addState(states, "0-ff");
break;
case UCNV_MBCS:
fprintf(stderr, "ucm error: missing state table information (<icu:state>) for MBCS\n");
exit(U_INVALID_TABLE_FORMAT);
break;
case UCNV_EBCDIC_STATEFUL:
/* EBCDIC_STATEFUL: use MBCS data structure with a default state table */
if(states->minCharLength!=1 || states->maxCharLength!=2) {
fprintf(stderr, "error: DBCS codepage with min B/char!=1 or max B/char!=2\n");
exit(U_INVALID_TABLE_FORMAT);
}
states->conversionType=UCNV_MBCS;
ucm_addState(states, "0-ff, e:1.s, f:0.s");
ucm_addState(states, "initial, 0-3f:4, e:1.s, f:0.s, 40:3, 41-fe:2, ff:4");
ucm_addState(states, "0-40:1.i, 41-fe:1., ff:1.i");
ucm_addState(states, "0-ff:1.i, 40:1.");
ucm_addState(states, "0-ff:1.i");
break;
case UCNV_DBCS:
/* DBCS: use MBCS data structure with a default state table */
if(states->minCharLength!=2 || states->maxCharLength!=2) {
fprintf(stderr, "error: DBCS codepage with min or max B/char!=2\n");
exit(U_INVALID_TABLE_FORMAT);
}
states->conversionType = UCNV_MBCS;
ucm_addState(states, "0-3f:3, 40:2, 41-fe:1, ff:3");
ucm_addState(states, "41-fe");
ucm_addState(states, "40");
ucm_addState(states, "");
break;
default:
fprintf(stderr, "ucm error: unknown charset structure\n");
exit(U_INVALID_TABLE_FORMAT);
break;
}
}
/*
* check that the min/max character lengths are reasonable;
* to do this right, all paths through the state table would have to be
* recursively walked while keeping track of the sequence lengths,
* but these simple checks cover most state tables in practice
*/
if(states->maxCharLength<states->minCharLength) {
fprintf(stderr, "ucm error: max B/char < min B/char\n");
exit(U_INVALID_TABLE_FORMAT);
}
/* count non-direct states and compare with max B/char */
count=0;
for(state=0; state<states->countStates; ++state) {
if((states->stateFlags[state]&0xf)!=MBCS_STATE_FLAG_DIRECT) {
++count;
}
}
if(states->maxCharLength>count+1) {
fprintf(stderr, "ucm error: max B/char too large\n");
exit(U_INVALID_TABLE_FORMAT);
}
if(states->minCharLength==1) {
int32_t action;
/*
* if there are single-byte characters,
* then the initial state must have direct result states
*/
for(cell=0; cell<256; ++cell) {
entry=states->stateTable[0][cell];
if( MBCS_ENTRY_IS_FINAL(entry) &&
((action=MBCS_ENTRY_FINAL_ACTION(entry))==MBCS_STATE_VALID_DIRECT_16 ||
action==MBCS_STATE_UNASSIGNED)
) {
break;
}
}
if(cell==256) {
fprintf(stderr, "ucm warning: min B/char too small\n");
}
}
/*
* make sure that all "next state" values are within limits
* and that all next states after final ones have the "direct"
* flag of initial states
*/
for(state=states->countStates-1; state>=0; --state) {
for(cell=0; cell<256; ++cell) {
entry=states->stateTable[state][cell];
if((uint8_t)MBCS_ENTRY_STATE(entry)>=states->countStates) {
fprintf(stderr, "ucm error: state table entry [%x][%x] has a next state of %x that is too high\n",
(int)state, (int)cell, (int)MBCS_ENTRY_STATE(entry));
exit(U_INVALID_TABLE_FORMAT);
}
if(MBCS_ENTRY_IS_FINAL(entry) && (states->stateFlags[MBCS_ENTRY_STATE(entry)]&0xf)!=MBCS_STATE_FLAG_DIRECT) {
fprintf(stderr, "ucm error: state table entry [%x][%x] is final but has a non-initial next state of %x\n",
(int)state, (int)cell, (int)MBCS_ENTRY_STATE(entry));
exit(U_INVALID_TABLE_FORMAT);
} else if(MBCS_ENTRY_IS_TRANSITION(entry) && (states->stateFlags[MBCS_ENTRY_STATE(entry)]&0xf)==MBCS_STATE_FLAG_DIRECT) {
fprintf(stderr, "ucm error: state table entry [%x][%x] is not final but has an initial next state of %x\n",
(int)state, (int)cell, (int)MBCS_ENTRY_STATE(entry));
exit(U_INVALID_TABLE_FORMAT);
}
}
}
/* is this an SI/SO (like EBCDIC-stateful) state table? */
if(states->countStates>=2 && (states->stateFlags[1]&0xf)==MBCS_STATE_FLAG_DIRECT) {
if(states->maxCharLength!=2) {
fprintf(stderr, "ucm error: SI/SO codepages must have max 2 bytes/char (not %x)\n", (int)states->maxCharLength);
exit(U_INVALID_TABLE_FORMAT);
}
if(states->countStates<3) {
fprintf(stderr, "ucm error: SI/SO codepages must have at least 3 states (not %x)\n", (int)states->countStates);
exit(U_INVALID_TABLE_FORMAT);
}
/* are the SI/SO all in the right places? */
if( ignoreSISOCheck ||
(states->stateTable[0][0xe]==MBCS_ENTRY_FINAL(1, MBCS_STATE_CHANGE_ONLY, 0) &&
states->stateTable[0][0xf]==MBCS_ENTRY_FINAL(0, MBCS_STATE_CHANGE_ONLY, 0) &&
states->stateTable[1][0xe]==MBCS_ENTRY_FINAL(1, MBCS_STATE_CHANGE_ONLY, 0) &&
states->stateTable[1][0xf]==MBCS_ENTRY_FINAL(0, MBCS_STATE_CHANGE_ONLY, 0))
) {
states->outputType=MBCS_OUTPUT_2_SISO;
} else {
fprintf(stderr, "ucm error: SI/SO codepages must have in states 0 and 1 transitions e:1.s, f:0.s\n");
exit(U_INVALID_TABLE_FORMAT);
}
state=2;
} else {
state=1;
}
/* check that no unexpected state is a "direct" one */
while(state<states->countStates) {
if((states->stateFlags[state]&0xf)==MBCS_STATE_FLAG_DIRECT) {
fprintf(stderr, "ucm error: state %d is 'initial' - not supported except for SI/SO codepages\n", (int)state);
exit(U_INVALID_TABLE_FORMAT);
}
++state;
}
sumUpStates(states);
}
/* find a fallback for this offset; return the index or -1 if not found */
U_CAPI int32_t U_EXPORT2
ucm_findFallback(_MBCSToUFallback *toUFallbacks, int32_t countToUFallbacks,
uint32_t offset) {
int32_t i;
if(countToUFallbacks==0) {
/* shortcut: most codepages do not have fallbacks from codepage to Unicode */
return -1;
}
/* do a linear search for the fallback mapping (the table is not yet sorted) */
for(i=0; i<countToUFallbacks; ++i) {
if(offset==toUFallbacks[i].offset) {
return i;
}
}
return -1;
}
/*
* This function tries to compact toUnicode tables for 2-byte codepages
* by finding lead bytes with all-unassigned trail bytes and adding another state
* for them.
*/
static void
compactToUnicode2(UCMStates *states,
uint16_t **pUnicodeCodeUnits,
_MBCSToUFallback *toUFallbacks, int32_t countToUFallbacks,
UBool verbose) {
int32_t (*oldStateTable)[256];
uint16_t count[256];
uint16_t *oldUnicodeCodeUnits;
int32_t entry, offset, oldOffset, trailOffset, oldTrailOffset, savings, sum;
int32_t i, j, leadState, trailState, newState, fallback;
uint16_t unit;
/* find the lead state */
if(states->outputType==MBCS_OUTPUT_2_SISO) {
/* use the DBCS lead state for SI/SO codepages */
leadState=1;
} else {
leadState=0;
}
/* find the main trail state: the most used target state */
uprv_memset(count, 0, sizeof(count));
for(i=0; i<256; ++i) {
entry=states->stateTable[leadState][i];
if(MBCS_ENTRY_IS_TRANSITION(entry)) {
++count[MBCS_ENTRY_TRANSITION_STATE(entry)];
}
}
trailState=0;
for(i=1; i<states->countStates; ++i) {
if(count[i]>count[trailState]) {
trailState=i;
}
}
/* count possible savings from lead bytes with all-unassigned results in all trail bytes */
uprv_memset(count, 0, sizeof(count));
savings=0;
/* for each lead byte */
for(i=0; i<256; ++i) {
entry=states->stateTable[leadState][i];
if(MBCS_ENTRY_IS_TRANSITION(entry) && (MBCS_ENTRY_TRANSITION_STATE(entry))==trailState) {
/* the offset is different for each lead byte */
offset=MBCS_ENTRY_TRANSITION_OFFSET(entry);
/* for each trail byte for this lead byte */
for(j=0; j<256; ++j) {
entry=states->stateTable[trailState][j];
switch(MBCS_ENTRY_FINAL_ACTION(entry)) {
case MBCS_STATE_VALID_16:
entry=offset+MBCS_ENTRY_FINAL_VALUE_16(entry);
if((*pUnicodeCodeUnits)[entry]==0xfffe && ucm_findFallback(toUFallbacks, countToUFallbacks, entry)<0) {
++count[i];
} else {
j=999; /* do not count for this lead byte because there are assignments */
}
break;
case MBCS_STATE_VALID_16_PAIR:
entry=offset+MBCS_ENTRY_FINAL_VALUE_16(entry);
if((*pUnicodeCodeUnits)[entry]==0xfffe) {
count[i]+=2;
} else {
j=999; /* do not count for this lead byte because there are assignments */
}
break;
default:
break;
}
}
if(j==256) {
/* all trail bytes for this lead byte are unassigned */
savings+=count[i];
} else {
count[i]=0;
}
}
}
/* subtract from the possible savings the cost of an additional state */
savings=savings*2-1024; /* count bytes, not 16-bit words */
if(savings<=0) {
return;
}
if(verbose) {
printf("compacting toUnicode data saves %ld bytes\n", (long)savings);
}
if(states->countStates>=MBCS_MAX_STATE_COUNT) {
fprintf(stderr, "cannot compact toUnicode because the maximum number of states is reached\n");
return;
}
/* make a copy of the state table */
oldStateTable=(int32_t (*)[256])uprv_malloc(states->countStates*1024);
if(oldStateTable==NULL) {
fprintf(stderr, "cannot compact toUnicode: out of memory\n");
return;
}
uprv_memcpy(oldStateTable, states->stateTable, states->countStates*1024);
/* add the new state */
/*
* this function does not catch the degenerate case where all lead bytes
* have all-unassigned trail bytes and the lead state could be removed
*/
newState=states->countStates++;
states->stateFlags[newState]=0;
/* copy the old trail state, turning all assigned states into unassigned ones */
for(i=0; i<256; ++i) {
entry=states->stateTable[trailState][i];
switch(MBCS_ENTRY_FINAL_ACTION(entry)) {
case MBCS_STATE_VALID_16:
case MBCS_STATE_VALID_16_PAIR:
states->stateTable[newState][i]=MBCS_ENTRY_FINAL_SET_ACTION_VALUE(entry, MBCS_STATE_UNASSIGNED, 0xfffe);
break;
default:
states->stateTable[newState][i]=entry;
break;
}
}
/* in the lead state, redirect all lead bytes with all-unassigned trail bytes to the new state */
for(i=0; i<256; ++i) {
if(count[i]>0) {
states->stateTable[leadState][i]=MBCS_ENTRY_SET_STATE(states->stateTable[leadState][i], newState);
}
}
/* sum up the new state table */
for(i=0; i<states->countStates; ++i) {
states->stateFlags[i]&=~MBCS_STATE_FLAG_READY;
}
sum=sumUpStates(states);
/* allocate a new, smaller code units array */
oldUnicodeCodeUnits=*pUnicodeCodeUnits;
if(sum==0) {
*pUnicodeCodeUnits=NULL;
if(oldUnicodeCodeUnits!=NULL) {
uprv_free(oldUnicodeCodeUnits);
}
uprv_free(oldStateTable);
return;
}
*pUnicodeCodeUnits=(uint16_t *)uprv_malloc(sum*sizeof(uint16_t));
if(*pUnicodeCodeUnits==NULL) {
fprintf(stderr, "cannot compact toUnicode: out of memory allocating %ld 16-bit code units\n",
(long)sum);
/* revert to the old state table */
*pUnicodeCodeUnits=oldUnicodeCodeUnits;
--states->countStates;
uprv_memcpy(states->stateTable, oldStateTable, states->countStates*1024);
uprv_free(oldStateTable);
return;
}
for(i=0; i<sum; ++i) {
(*pUnicodeCodeUnits)[i]=0xfffe;
}
/* copy the code units for all assigned characters */
/*
* The old state table has the same lead _and_ trail states for assigned characters!
* The differences are in the offsets, and in the trail states for some unassigned characters.
* For each character with an assigned state in the new table, it was assigned in the old one.
* Only still-assigned characters are copied.
* Note that fallback mappings need to get their offset values adjusted.
*/
/* for each initial state */
for(leadState=0; leadState<states->countStates; ++leadState) {
if((states->stateFlags[leadState]&0xf)==MBCS_STATE_FLAG_DIRECT) {
/* for each lead byte from there */
for(i=0; i<256; ++i) {
entry=states->stateTable[leadState][i];
if(MBCS_ENTRY_IS_TRANSITION(entry)) {
trailState=(uint8_t)MBCS_ENTRY_TRANSITION_STATE(entry);
/* the new state does not have assigned states */
if(trailState!=newState) {
trailOffset=MBCS_ENTRY_TRANSITION_OFFSET(entry);
oldTrailOffset=MBCS_ENTRY_TRANSITION_OFFSET(oldStateTable[leadState][i]);
/* for each trail byte */
for(j=0; j<256; ++j) {
entry=states->stateTable[trailState][j];
/* copy assigned-character code units and adjust fallback offsets */
switch(MBCS_ENTRY_FINAL_ACTION(entry)) {
case MBCS_STATE_VALID_16:
offset=trailOffset+MBCS_ENTRY_FINAL_VALUE_16(entry);
/* find the old offset according to the old state table */
oldOffset=oldTrailOffset+MBCS_ENTRY_FINAL_VALUE_16(oldStateTable[trailState][j]);
unit=(*pUnicodeCodeUnits)[offset]=oldUnicodeCodeUnits[oldOffset];
if(unit==0xfffe && (fallback=ucm_findFallback(toUFallbacks, countToUFallbacks, oldOffset))>=0) {
toUFallbacks[fallback].offset=0x80000000|offset;
}
break;
case MBCS_STATE_VALID_16_PAIR:
offset=trailOffset+MBCS_ENTRY_FINAL_VALUE_16(entry);
/* find the old offset according to the old state table */
oldOffset=oldTrailOffset+MBCS_ENTRY_FINAL_VALUE_16(oldStateTable[trailState][j]);
(*pUnicodeCodeUnits)[offset++]=oldUnicodeCodeUnits[oldOffset++];
(*pUnicodeCodeUnits)[offset]=oldUnicodeCodeUnits[oldOffset];
break;
default:
break;
}
}
}
}
}
}
}
/* remove temporary flags from fallback offsets that protected them from being modified twice */
for(i=0; i<countToUFallbacks; ++i) {
toUFallbacks[i].offset&=0x7fffffff;
}
/* free temporary memory */
uprv_free(oldUnicodeCodeUnits);
uprv_free(oldStateTable);
}
/*
* recursive sub-function of compactToUnicodeHelper()
* returns:
* >0 number of bytes that are used in unicodeCodeUnits[] that could be saved,
* if all sequences from this state are unassigned, returns the
* <0 there are assignments in unicodeCodeUnits[]
* 0 no use of unicodeCodeUnits[]
*/
static int32_t
findUnassigned(UCMStates *states,
uint16_t *unicodeCodeUnits,
_MBCSToUFallback *toUFallbacks, int32_t countToUFallbacks,
int32_t state, int32_t offset, uint32_t b) {
int32_t i, entry, savings, localSavings, belowSavings;
UBool haveAssigned;
localSavings=belowSavings=0;
haveAssigned=FALSE;
for(i=0; i<256; ++i) {
entry=states->stateTable[state][i];
if(MBCS_ENTRY_IS_TRANSITION(entry)) {
savings=findUnassigned(states,
unicodeCodeUnits,
toUFallbacks, countToUFallbacks,
MBCS_ENTRY_TRANSITION_STATE(entry),
offset+MBCS_ENTRY_TRANSITION_OFFSET(entry),
(b<<8)|(uint32_t)i);
if(savings<0) {
haveAssigned=TRUE;
} else if(savings>0) {
printf(" all-unassigned sequences from prefix 0x%02lx state %ld use %ld bytes\n",
(unsigned long)((b<<8)|i), (long)state, (long)savings);
belowSavings+=savings;
}
} else if(!haveAssigned) {
switch(MBCS_ENTRY_FINAL_ACTION(entry)) {
case MBCS_STATE_VALID_16:
entry=offset+MBCS_ENTRY_FINAL_VALUE_16(entry);
if(unicodeCodeUnits[entry]==0xfffe && ucm_findFallback(toUFallbacks, countToUFallbacks, entry)<0) {
localSavings+=2;
} else {
haveAssigned=TRUE;
}
break;
case MBCS_STATE_VALID_16_PAIR:
entry=offset+MBCS_ENTRY_FINAL_VALUE_16(entry);
if(unicodeCodeUnits[entry]==0xfffe) {
localSavings+=4;
} else {
haveAssigned=TRUE;
}
break;
default:
break;
}
}
}
if(haveAssigned) {
return -1;
} else {
return localSavings+belowSavings;
}
}
/* helper function for finding compaction opportunities */
static void
compactToUnicodeHelper(UCMStates *states,
uint16_t *unicodeCodeUnits,
_MBCSToUFallback *toUFallbacks, int32_t countToUFallbacks) {
int32_t state, savings;
/* for each initial state */
for(state=0; state<states->countStates; ++state) {
if((states->stateFlags[state]&0xf)==MBCS_STATE_FLAG_DIRECT) {
savings=findUnassigned(states,
unicodeCodeUnits,
toUFallbacks, countToUFallbacks,
state, 0, 0);
if(savings>0) {
printf(" all-unassigned sequences from initial state %ld use %ld bytes\n",
(long)state, (long)savings);
}
}
}
}
U_CDECL_BEGIN
static int32_t U_CALLCONV
compareFallbacks(const void *context, const void *fb1, const void *fb2) {
(void)context;
return ((const _MBCSToUFallback *)fb1)->offset-((const _MBCSToUFallback *)fb2)->offset;
}
U_CDECL_END
U_CAPI void U_EXPORT2
ucm_optimizeStates(UCMStates *states,
uint16_t **pUnicodeCodeUnits,
_MBCSToUFallback *toUFallbacks, int32_t countToUFallbacks,
UBool verbose) {
UErrorCode errorCode;
int32_t state, cell, entry;
/* test each state table entry */
for(state=0; state<states->countStates; ++state) {
for(cell=0; cell<256; ++cell) {
entry=states->stateTable[state][cell];
/*
* if the entry is a final one with an MBCS_STATE_VALID_DIRECT_16 action code
* and the code point is "unassigned" (0xfffe), then change it to
* the "unassigned" action code with bits 26..23 set to zero and U+fffe.
*/
if(MBCS_ENTRY_SET_STATE(entry, 0)==MBCS_ENTRY_FINAL(0, MBCS_STATE_VALID_DIRECT_16, 0xfffe)) {
states->stateTable[state][cell]=MBCS_ENTRY_FINAL_SET_ACTION(entry, MBCS_STATE_UNASSIGNED);
}
}
}
/* try to compact the toUnicode tables */
if(states->maxCharLength==2) {
compactToUnicode2(states, pUnicodeCodeUnits, toUFallbacks, countToUFallbacks, verbose);
} else if(states->maxCharLength>2) {
if(verbose) {
compactToUnicodeHelper(states, *pUnicodeCodeUnits, toUFallbacks, countToUFallbacks);
}
}
/* sort toUFallbacks */
/*
* It should be safe to sort them before compactToUnicode2() is called,
* because it should not change the relative order of the offset values
* that it adjusts, but they need to be sorted at some point, and
* it is safest here.
*/
if(countToUFallbacks>0) {
errorCode=U_ZERO_ERROR; /* nothing bad will happen... */
uprv_sortArray(toUFallbacks, countToUFallbacks,
sizeof(_MBCSToUFallback),
compareFallbacks, NULL, FALSE, &errorCode);
}
}
/* use a complete state table ----------------------------------------------- */
U_CAPI int32_t U_EXPORT2
ucm_countChars(UCMStates *states,
const uint8_t *bytes, int32_t length) {
uint32_t offset;
int32_t i, entry, count;
uint8_t state;
offset=0;
count=0;
state=0;
if(states->countStates==0) {
fprintf(stderr, "ucm error: there is no state information!\n");
return -1;
}
/* for SI/SO (like EBCDIC-stateful), double-byte sequences start in state 1 */
if(length==2 && states->outputType==MBCS_OUTPUT_2_SISO) {
state=1;
}
/*
* Walk down the state table like in conversion,
* much like getNextUChar().
* We assume that c<=0x10ffff.
*/
for(i=0; i<length; ++i) {
entry=states->stateTable[state][bytes[i]];
if(MBCS_ENTRY_IS_TRANSITION(entry)) {
state=(uint8_t)MBCS_ENTRY_TRANSITION_STATE(entry);
offset+=MBCS_ENTRY_TRANSITION_OFFSET(entry);
} else {
switch(MBCS_ENTRY_FINAL_ACTION(entry)) {
case MBCS_STATE_ILLEGAL:
fprintf(stderr, "ucm error: byte sequence ends in illegal state\n");
return -1;
case MBCS_STATE_CHANGE_ONLY:
fprintf(stderr, "ucm error: byte sequence ends in state-change-only\n");
return -1;
case MBCS_STATE_UNASSIGNED:
case MBCS_STATE_FALLBACK_DIRECT_16:
case MBCS_STATE_VALID_DIRECT_16:
case MBCS_STATE_FALLBACK_DIRECT_20:
case MBCS_STATE_VALID_DIRECT_20:
case MBCS_STATE_VALID_16:
case MBCS_STATE_VALID_16_PAIR:
/* count a complete character and prepare for a new one */
++count;
state=(uint8_t)MBCS_ENTRY_FINAL_STATE(entry);
offset=0;
break;
default:
/* reserved, must never occur */
fprintf(stderr, "ucm error: byte sequence reached reserved action code, entry: 0x%02lx\n", (unsigned long)entry);
return -1;
}
}
}
if(offset!=0) {
fprintf(stderr, "ucm error: byte sequence too short, ends in non-final state %u\n", state);
return -1;
}
/*
* for SI/SO (like EBCDIC-stateful), multiple-character results
* must consist of only double-byte sequences
*/
if(count>1 && states->outputType==MBCS_OUTPUT_2_SISO && length!=2*count) {
fprintf(stderr, "ucm error: SI/SO (like EBCDIC-stateful) result with %d characters does not contain all DBCS\n", (int)count);
return -1;
}
return count;
}
#endif
```
|
```css
@keyframes elementor-animation-bob{0%{transform:translateY(-8px)}50%{transform:translateY(-4px)}100%{transform:translateY(-8px)}}@keyframes elementor-animation-bob-float{100%{transform:translateY(-8px)}}.elementor-animation-bob:active,.elementor-animation-bob:focus,.elementor-animation-bob:hover{animation-name:elementor-animation-bob-float,elementor-animation-bob;animation-duration:.3s,1.5s;animation-delay:0s,.3s;animation-timing-function:ease-out,ease-in-out;animation-iteration-count:1,infinite;animation-fill-mode:forwards;animation-direction:normal,alternate}
```
|
```objective-c
/*
* PROGRAM: JRD Access Method
* MODULE: flu_proto.h
* DESCRIPTION: Prototype header file for flu.cpp, functions.cpp,
* builtin.cpp and qatest.cpp
*
* The contents of this file are subject to the Interbase Public
*
* "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express
*
* The Original Code was created by Inprise Corporation
* and its predecessors. Portions created by Inprise Corporation are
*
* All Rights Reserved.
* Contributor(s): ______________________________________.
*/
#ifndef JRD_FLU_PROTO_H
#define JRD_FLU_PROTO_H
FPTR_INT BUILTIN_entrypoint(const TEXT*, const TEXT*);
FPTR_INT FUNCTIONS_entrypoint(const char*, const char*);
#endif // JRD_FLU_PROTO_H
```
|
Mihály Balla (born 21 May 1965) is a Hungarian politician, member of the National Assembly (MP) for Balassagyarmat, Nógrád County (Constituency IV then II) since 1998. He is one of the deputy leaders of the Fidesz parliamentary group since 8 June 2010. He served as Chairman of the Parliamentary Committee on Foreign Affairs from 2010 to 2014.
Career
Balla graduated as a teacher of Hungarian and Russian from Bessenyei György Teacher Training College in 1987. He took his advanced degree in Hungarian language and literature from University of Miskolc in 1998. He has been a member of the Board of Trustees of the Foundation for the Development of Balassagyarmat since 1998.
He joined to the Fidesz in 1997 and has been Vice President of the Nógrád County Board since 1998. He secured a seat in Parliament in the 1998 parliamentary elections as an individual candidate (representing Constituency IV, Balassagyarmat, Nógrád County). When Fidesz developed its organisational structure in the course of 2003 and 2004 he was appointed to the post of chairman of the Balassagyarmat Constituency.
He led the Hungarian parliamentary group delegated to the Organization for Security and Co-operation in Europe (OSCE) and the Hungarian parliamentary delegation to NATO Parliamentary Assembly from 1998 to 2002. As deputy chairman of the Foreign Affairs Committee he headed the foreign and security policy cabinet of the parliamentary group of Fidesz from 1999. He had been deputy parliamentary faction leader for Fidesz from 28 April 2000 to 2002. As an individual candidate he secured incumbency as the MP for his Balassagyarmat Constituency in the second round of the parliamentary elections in April 2002. Once Parliament was established he was chairman of the Foreign Affairs Committee for a brief period, then worked as a member, and had been deputy chairman since June 2003. He ran in the local elections in October 2002 and secured a seat in the Nógrád County Assembly as well as in the body of representatives of Érsekvadkert. He was a delegate to the European Parliament from the autumn of 2002 to the summer of 2004. He served as Deputy Chairman of the Hungarian delegation to the Interparliamentary Union from 2008 to 2014. He was elected head of the delegation on 10 June 2014.
He could repeat his success in 2006 2010, 2014 and 2018 as Member of Parliament for Balassagyarmat. Balla was appointed Chairman of the Parliamentary Committee on Foreign Affairs on May 14, 2010, holding the position until June 2014.
References
1965 births
Living people
Fidesz politicians
Members of the National Assembly of Hungary (1998–2002)
Members of the National Assembly of Hungary (2002–2006)
Members of the National Assembly of Hungary (2006–2010)
Members of the National Assembly of Hungary (2010–2014)
Members of the National Assembly of Hungary (2014–2018)
Members of the National Assembly of Hungary (2018–2022)
Members of the National Assembly of Hungary (2022–2026)
People from Nyíregyháza
|
```java
package com.fishercoder.solutions.secondthousand;
public class _1758 {
public static class Solution1 {
public int minOperations(String s) {
int ops1 = 0;
//start with 0
boolean isZero = true;
for (int i = 0; i < s.length(); i++) {
if (i % 2 == 0) {
//should be zero, if not, change it to zero and increase ops1 by one
if (s.charAt(i) != '0') {
ops1++;
}
} else {
//should be one, if not, increase ops1 by one
if (s.charAt(i) != '1') {
ops1++;
}
}
}
//start with 1
int ops2 = 0;
for (int i = 0; i < s.length(); i++) {
if (i % 2 == 0) {
//should be one, if not, increase ops2 by one
if (s.charAt(i) != '1') {
ops2++;
}
} else {
if (s.charAt(i) != '0') {
ops2++;
}
}
}
return Math.min(ops1, ops2);
}
}
}
```
|
```javascript
Type of the Children props
componentWillReceiveProps Not Triggered After Mounting
Use **React** with other libraries
Server-side rendering
Enhanced Prop Validation
```
|
```shell
#!/usr/bin/env bash
#
#
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
current_userid=$(id -u)
if [ $current_userid -ne 0 ]; then
echo "$(basename "$0") uninstallation script requires superuser privileges to run"
exit 1
fi
host_package_name="dotnet-host"
aspnetcore_runtime_package_name="^aspnetcore-runtime.*"
remove_all(){
apt-get purge -y $aspnetcore_runtime_package_name
apt-get purge -y $host_package_name
}
is_dotnet_host_installed(){
local out="$(dpkg -l | grep $host_package_name)"
[ -z "$out" ]
}
dotnet_tool_path_file="/etc/profile.d/dotnet-cli-tools-bin-path.sh"
rm -f "$dotnet_tool_path_file"
is_dotnet_host_installed
[ "$?" -eq 0 ] && echo "Unable to find dotnet installation to remove." >&2 \
&& exit 0
remove_all
[ "$?" -ne 0 ] && echo "Failed to remove dotnet packages." >&2 && exit 1
is_dotnet_host_installed
[ "$?" -ne 0 ] && \
echo "dotnet package removal succeeded but appear to still be installed. File an issue at path_to_url" >&2 && \
exit 1
echo "dotnet package removal succeeded." >&2
exit 0
```
|
```java
/*
*/
package io.strimzi.api.kafka.model.user.acl;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
public enum AclOperation {
READ,
WRITE,
CREATE,
DELETE,
ALTER,
DESCRIBE,
CLUSTERACTION,
ALTERCONFIGS,
DESCRIBECONFIGS,
IDEMPOTENTWRITE,
ALL;
@JsonCreator
public static AclOperation forValue(String value) {
switch (value) {
case "Read":
return READ;
case "Write":
return WRITE;
case "Create":
return CREATE;
case "Delete":
return DELETE;
case "Alter":
return ALTER;
case "Describe":
return DESCRIBE;
case "ClusterAction":
return CLUSTERACTION;
case "AlterConfigs":
return ALTERCONFIGS;
case "DescribeConfigs":
return DESCRIBECONFIGS;
case "IdempotentWrite":
return IDEMPOTENTWRITE;
case "All":
return ALL;
default:
return null;
}
}
@JsonValue
public String toValue() {
switch (this) {
case READ:
return "Read";
case WRITE:
return "Write";
case CREATE:
return "Create";
case DELETE:
return "Delete";
case ALTER:
return "Alter";
case DESCRIBE:
return "Describe";
case CLUSTERACTION:
return "ClusterAction";
case ALTERCONFIGS:
return "AlterConfigs";
case DESCRIBECONFIGS:
return "DescribeConfigs";
case IDEMPOTENTWRITE:
return "IdempotentWrite";
case ALL:
return "All";
default:
return null;
}
}
}
```
|
```python
import unittest
import resource
import random
import struct
import errno
import math
import time
import sys
from pyverbs.providers.mlx5.mlx5dv import Mlx5Context, Mlx5DVContextAttr, \
Mlx5DVQPInitAttr, Mlx5QP, Mlx5DVDCInitAttr, Mlx5DCIStreamInitAttr, \
Mlx5DevxObj, Mlx5UMEM, Mlx5UAR, WqeDataSeg, WqeCtrlSeg, Wqe, Mlx5Cqe64, \
Mlx5DVCQInitAttr, Mlx5CQ
from tests.base import RoCETrafficResources, set_rnr_attributes, DCT_KEY, \
RDMATestCase, PyverbsAPITestCase, RDMACMBaseTest, BaseResources, PATH_MTU, \
RNR_RETRY, RETRY_CNT, MIN_RNR_TIMER, TIMEOUT, MAX_RDMA_ATOMIC, RCResources, \
is_gid_available
from pyverbs.pyverbs_error import PyverbsRDMAError, PyverbsUserError, \
PyverbsError
from pyverbs.providers.mlx5.mlx5dv_objects import Mlx5DvObj
from pyverbs.qp import QPCap, QPInitAttrEx, QPAttr
import pyverbs.providers.mlx5.mlx5_enums as dve
from pyverbs.addr import AHAttr, GlobalRoute
from pyverbs.cq import CqInitAttrEx
import pyverbs.mem_alloc as mem
import pyverbs.dma_util as dma
import pyverbs.device as d
from pyverbs.pd import PD
import pyverbs.enums as e
from pyverbs.mr import MR
import tests.utils
MLX5_CQ_SET_CI = 0
POLL_CQ_TIMEOUT = 5 # In seconds
PORT_STATE_TIMEOUT = 20 # In seconds
MELLANOX_VENDOR_ID = 0x02c9
MLX5_DEVS = {
0x1011, # MT4113 Connect-IB
0x1012, # Connect-IB Virtual Function
0x1013, # ConnectX-4
0x1014, # ConnectX-4 Virtual Function
0x1015, # ConnectX-4LX
0x1016, # ConnectX-4LX Virtual Function
0x1017, # ConnectX-5, PCIe 3.0
0x1018, # ConnectX-5 Virtual Function
0x1019, # ConnectX-5 Ex
0x101a, # ConnectX-5 Ex VF
0x101b, # ConnectX-6
0x101c, # ConnectX-6 VF
0x101d, # ConnectX-6 DX
0x101e, # ConnectX family mlx5Gen Virtual Function
0x101f, # ConnectX-6 LX
0x1021, # ConnectX-7
0x1023, # ConnectX-8
0xa2d2, # BlueField integrated ConnectX-5 network controller
0xa2d3, # BlueField integrated ConnectX-5 network controller VF
0xa2d6, # BlueField-2 integrated ConnectX-6 Dx network controller
0xa2dc, # BlueField-3 integrated ConnectX-7 network controller
0xa2df, # BlueField-4 integrated ConnectX-8 network controller
}
DCI_TEST_GOOD_FLOW = 0
DCI_TEST_BAD_FLOW_WITH_RESET = 1
DCI_TEST_BAD_FLOW_WITHOUT_RESET = 2
IB_SMP_ATTR_PORT_INFO = 0x0015
IB_MGMT_CLASS_SUBN_LID_ROUTED = 0x01
IB_MGMT_METHOD_GET = 0x01
DB_BF_DBR_LESS_BUF_OFFSET = 0x600
class PortStatus:
MLX5_PORT_UP = 1
MLX5_PORT_DOWN = 2
class PortState:
NO_STATE_CHANGE = 0
DOWN = 1
INIT = 2
ARMED = 3
ACTIVE = 4
def is_mlx5_dev(ctx):
dev_attrs = ctx.query_device()
return dev_attrs.vendor_id == MELLANOX_VENDOR_ID and \
dev_attrs.vendor_part_id in MLX5_DEVS
def skip_if_not_mlx5_dev(ctx):
if not is_mlx5_dev(ctx):
raise unittest.SkipTest('Can not run the test over non MLX5 device')
class Mlx5PyverbsAPITestCase(PyverbsAPITestCase):
def setUp(self):
super().setUp()
skip_if_not_mlx5_dev(self.ctx)
class Mlx5RDMATestCase(RDMATestCase):
def setUp(self):
super().setUp()
skip_if_not_mlx5_dev(d.Context(name=self.dev_name))
class Mlx5RDMACMBaseTest(RDMACMBaseTest):
def setUp(self):
super().setUp()
skip_if_not_mlx5_dev(d.Context(name=self.dev_name))
class Mlx5DcResources(RoCETrafficResources):
def __init__(self, dev_name, ib_port, gid_index, send_ops_flags,
qp_count=1, create_flags=0):
self.send_ops_flags = send_ops_flags
self.create_flags = create_flags
super().__init__(dev_name, ib_port, gid_index, with_srq=True,
qp_count=qp_count)
def to_rts(self):
attr = self.create_qp_attr()
for i in range(self.qp_count):
self.qps[i].to_rts(attr)
self.dct_qp.to_rtr(attr)
def create_context(self):
mlx5dv_attr = Mlx5DVContextAttr()
try:
self.ctx = Mlx5Context(mlx5dv_attr, name=self.dev_name)
except PyverbsUserError as ex:
raise unittest.SkipTest(f'Could not open mlx5 context ({ex})')
except PyverbsRDMAError:
raise unittest.SkipTest('Opening mlx5 context is not supported')
def create_mr(self):
access = e.IBV_ACCESS_REMOTE_WRITE | e.IBV_ACCESS_LOCAL_WRITE | \
e.IBV_ACCESS_REMOTE_ATOMIC | e.IBV_ACCESS_REMOTE_READ
self.mr = MR(self.pd, self.msg_size, access)
def create_qp_cap(self):
return QPCap(100, 0, 1, 0)
def create_qp_attr(self):
qp_attr = QPAttr(port_num=self.ib_port)
set_rnr_attributes(qp_attr)
qp_access = e.IBV_ACCESS_LOCAL_WRITE | e.IBV_ACCESS_REMOTE_WRITE | \
e.IBV_ACCESS_REMOTE_ATOMIC | e.IBV_ACCESS_REMOTE_READ
qp_attr.qp_access_flags = qp_access
gr = GlobalRoute(dgid=self.ctx.query_gid(self.ib_port, self.gid_index),
sgid_index=self.gid_index)
ah_attr = AHAttr(port_num=self.ib_port, is_global=1, gr=gr,
dlid=self.port_attr.lid)
qp_attr.ah_attr = ah_attr
return qp_attr
def create_qp_init_attr(self, send_ops_flags=0):
comp_mask = e.IBV_QP_INIT_ATTR_PD
if send_ops_flags:
comp_mask |= e.IBV_QP_INIT_ATTR_SEND_OPS_FLAGS
return QPInitAttrEx(cap=self.create_qp_cap(), pd=self.pd, scq=self.cq,
rcq=self.cq, srq=self.srq, qp_type=e.IBV_QPT_DRIVER,
send_ops_flags=send_ops_flags, comp_mask=comp_mask,
sq_sig_all=1)
def create_qps(self):
# Create the DCI QPs.
qp_init_attr = self.create_qp_init_attr(self.send_ops_flags)
try:
for _ in range(self.qp_count):
comp_mask = dve.MLX5DV_QP_INIT_ATTR_MASK_DC
if self.create_flags:
comp_mask |= dve.MLX5DV_QP_INIT_ATTR_MASK_QP_CREATE_FLAGS
attr = Mlx5DVQPInitAttr(comp_mask=comp_mask,
create_flags=self.create_flags,
dc_init_attr=Mlx5DVDCInitAttr())
qp = Mlx5QP(self.ctx, qp_init_attr, attr)
self.qps.append(qp)
self.qps_num.append(qp.qp_num)
self.psns.append(random.getrandbits(24))
# Create the DCT QP.
qp_init_attr = self.create_qp_init_attr()
dc_attr = Mlx5DVDCInitAttr(dc_type=dve.MLX5DV_DCTYPE_DCT,
dct_access_key=DCT_KEY)
attr = Mlx5DVQPInitAttr(comp_mask=dve.MLX5DV_QP_INIT_ATTR_MASK_DC,
dc_init_attr=dc_attr)
self.dct_qp = Mlx5QP(self.ctx, qp_init_attr, attr)
except PyverbsRDMAError as ex:
if ex.error_code == errno.EOPNOTSUPP:
raise unittest.SkipTest(f'Create DC QP is not supported')
raise ex
class Mlx5DcStreamsRes(Mlx5DcResources):
def __init__(self, dev_name, ib_port, gid_index, send_ops_flags,
qp_count=1, create_flags=0):
self.bad_flow = 0
self.mr_bad_flow = False
self.stream_check = False
super().__init__(dev_name, ib_port, gid_index, send_ops_flags,
qp_count, create_flags)
def reset_qp(self, qp_idx):
qp_attr = QPAttr(qp_state=e.IBV_QPS_RESET)
self.qps[qp_idx].modify(qp_attr, e.IBV_QP_STATE)
self.qps[qp_idx].to_rts(qp_attr)
self.qp_stream_errors[qp_idx][0] = 0
def get_stream_id(self, qp_idx):
return self.current_qp_stream_id[qp_idx]
def generate_stream_id(self, qp_idx):
self.current_qp_stream_id[qp_idx] += 1
# Reset stream id to check double-usage
if self.current_qp_stream_id[qp_idx] > self.dcis[qp_idx]['stream']+2:
self.current_qp_stream_id[qp_idx] = 1
return self.current_qp_stream_id[qp_idx]
def dci_reset_stream_id(self, qp_idx):
stream_id = self.get_stream_id(qp_idx)
Mlx5QP.modify_dci_stream_channel_id(self.qps[qp_idx], stream_id)
# Check once if error raised when reset wrong stream id
if self.stream_check:
try:
Mlx5QP.modify_dci_stream_channel_id(self.qps[qp_idx],
stream_id+1)
except PyverbsRDMAError as ex:
self.stream_check = False
def bad_flow_handler_qp(self, qp_idx, status, reset=False):
str_id = self.get_stream_id(qp_idx)
bt_stream = (1 << str_id)
if status == e.IBV_WC_LOC_PROT_ERR:
self.qp_stream_errors[qp_idx][1] += 1
if (self.qp_stream_errors[qp_idx][0] & bt_stream) != 0:
raise PyverbsError(f'Dublicate error from stream id {str_id}')
self.qp_stream_errors[qp_idx][0] |= bt_stream
if status == e.IBV_WC_WR_FLUSH_ERR:
qp_attr, _ = self.qps[qp_idx].query(e.IBV_QP_STATE)
if qp_attr.cur_qp_state == e.IBV_QPS_ERR and reset:
if self.qp_stream_errors[qp_idx][1] != self.dcis[qp_idx]['errored']:
msg = f'QP {qp_idx} in ERR state with wrong number of counter'
raise PyverbsError(msg)
self.reset_qp(qp_idx)
self.qp_stream_errors[qp_idx][2] = True
return True
def bad_flow_handling(self, qp_idx, status, reset=False):
if self.bad_flow == DCI_TEST_GOOD_FLOW:
return False
if self.bad_flow == DCI_TEST_BAD_FLOW_WITH_RESET:
self.qp_stream_errors[qp_idx][1] += 1
if reset:
self.dci_reset_stream_id(qp_idx)
return True
if self.bad_flow == DCI_TEST_BAD_FLOW_WITHOUT_RESET:
return self.bad_flow_handler_qp(qp_idx, status, reset)
return False
def set_bad_flow(self, bad_flow):
self.bad_flow = bad_flow
if self.bad_flow:
if bad_flow == DCI_TEST_BAD_FLOW_WITH_RESET and self.log_dci_errored == 0:
raise unittest.SkipTest('DCS test of bad flow with reset is not '
'supported when HCA_CAP.log_dci_errored is 0')
self.pd_bad = PD(self.ctx)
self.mr_bad_flow = False
if bad_flow == DCI_TEST_BAD_FLOW_WITH_RESET:
self.stream_check = True
def is_bad_flow(self, qp_idx):
cnt = self.get_stream_id(qp_idx)
if self.bad_flow == DCI_TEST_GOOD_FLOW:
return False
if self.bad_flow == DCI_TEST_BAD_FLOW_WITH_RESET:
if (cnt % 3) != 0:
return False
self.qp_stream_errors[qp_idx][0] += 1
if self.bad_flow == DCI_TEST_BAD_FLOW_WITHOUT_RESET:
if self.qp_stream_errors[qp_idx][2]:
return False
return True
def check_bad_flow(self, qp_idx):
change_mr = False
if self.is_bad_flow(qp_idx):
if not self.mr_bad_flow:
self.mr_bad_flow = True
pd = self.pd_bad
change_mr = True
else:
if self.mr_bad_flow:
self.mr_bad_flow = False
pd = self.pd
change_mr = True
if change_mr:
self.mr.rereg(flags=e.IBV_REREG_MR_CHANGE_PD, pd=pd,
addr=0, length=0, access=0)
def check_after_traffic(self):
if self.bad_flow == DCI_TEST_BAD_FLOW_WITH_RESET:
for errs in self.qp_stream_errors:
if errs[0] != errs[1]:
msg = f'Number of qp_stream_errors {errs[0]} not same '\
f'as number of catches {errs[1]}'
raise PyverbsError(msg)
if self.stream_check:
msg = 'Reset of good stream id does not create exception'
raise PyverbsError(msg)
def generate_dci_attr(self, qpn):
# This array contains current number of log_dci_streams
# and log_dci_errored values per qp. For 1-st qp number
# of streams greater than number of errored and vice-versa
# for the 2nd qp.
qp_arr = {0: [3, 2], 1: [2, 3]}
try:
dci_caps = self.ctx.query_mlx5_device().dci_streams_caps
except PyverbsRDMAError as ex:
if ex.error_code in [errno.EOPNOTSUPP, errno.EPROTONOSUPPORT]:
raise unittest.SkipTest('Get DCI caps is not supported')
raise ex
if not dci_caps or dci_caps['max_log_num_concurent'] == 0:
raise unittest.SkipTest('DCI caps is not supported by HW')
self.log_dci_streams = min(qp_arr.get(qpn, [1,1])[0],
dci_caps['max_log_num_concurent'])
self.log_dci_errored = min(qp_arr.get(qpn, [1,1])[1],
dci_caps['max_log_num_errored'])
def create_qps(self):
# Create the DCI QPs.
qp_init_attr = self.create_qp_init_attr(self.send_ops_flags)
self.dcis = {}
# This array contains current stream id
self.current_qp_stream_id = {}
# This array counts different errors in bad_flow
self.qp_stream_errors = []
comp_mask = dve.MLX5DV_QP_INIT_ATTR_MASK_DC | \
dve.MLX5DV_QP_INIT_ATTR_MASK_DCI_STREAMS
try:
for qpn in range(self.qp_count):
if self.create_flags:
comp_mask |= dve.MLX5DV_QP_INIT_ATTR_MASK_QP_CREATE_FLAGS
self.generate_dci_attr(qpn)
stream_ctx = Mlx5DCIStreamInitAttr(self.log_dci_streams,
self.log_dci_errored)
self.dcis[qpn] = {'stream': 1 << self.log_dci_streams,
'errored': 1 << self.log_dci_errored}
attr = Mlx5DVQPInitAttr(comp_mask=comp_mask,
create_flags=self.create_flags,
dc_init_attr=Mlx5DVDCInitAttr(dci_streams=stream_ctx))
qp = Mlx5QP(self.ctx, qp_init_attr, attr)
self.qps.append(qp)
# Different values for start point of stream id per qp
self.current_qp_stream_id[qpn] = qpn
# Array of errors for bad_flow
# For DCI_TEST_BAD_FLOW_WITH_RESET
# First element - number of injected bad flows
# Second element - number of exceptions from bad flows
# For DCI_TEST_BAD_FLOW_WITHOUT_RESET
# First element - bitmap of bad flow streams
# Second element - number of exceptions from bad flows
# Third element - flag if reset of qp been executed
self.qp_stream_errors.append([0, 0, False])
self.qps_num.append(qp.qp_num)
self.psns.append(random.getrandbits(24))
# Create the DCT QP.
qp_init_attr = self.create_qp_init_attr()
dc_attr = Mlx5DVDCInitAttr(dc_type=dve.MLX5DV_DCTYPE_DCT,
dct_access_key=DCT_KEY)
attr = Mlx5DVQPInitAttr(comp_mask=dve.MLX5DV_QP_INIT_ATTR_MASK_DC,
dc_init_attr=dc_attr)
self.dct_qp = Mlx5QP(self.ctx, qp_init_attr, attr)
except PyverbsRDMAError as ex:
if ex.error_code in [errno.EOPNOTSUPP, errno.EPROTONOSUPPORT]:
raise unittest.SkipTest('Create DC QP is not supported')
raise ex
@staticmethod
def traffic_with_bad_flow(client, server, iters, gid_idx, port):
"""
Runs basic traffic with bad flow between two sides
:param client: client side, clients base class is BaseTraffic
:param server: server side, servers base class is BaseTraffic
:param iters: number of traffic iterations
:param gid_idx: local gid index
:param port: IB port
:return: None
"""
import tests.utils as u
send_op = e.IBV_WR_SEND
ah_client = u.get_global_ah(client, gid_idx, port)
s_recv_wr = u.get_recv_wr(server)
c_recv_wr = u.get_recv_wr(client)
for qp_idx in range(server.qp_count):
# Prepare the receive queue with RecvWR
u.post_recv(client, c_recv_wr, qp_idx=qp_idx)
u.post_recv(server, s_recv_wr, qp_idx=qp_idx)
read_offset = 0
for _ in range(iters):
for qp_idx in range(server.qp_count):
_, c_send_object = u.get_send_elements(client, False)
u.send(client, c_send_object, send_op, True, qp_idx,
ah_client, False)
try:
wcs = u._poll_cq(client.cq)
except PyverbsError as ex:
if client.bad_flow_handling(qp_idx, e.IBV_WC_SUCCESS, True):
continue
raise ex
else:
if wcs[0].status != e.IBV_WC_SUCCESS and \
client.bad_flow_handling(qp_idx, wcs[0].status, True):
continue
u.poll_cq(server.cq)
u.post_recv(server, s_recv_wr, qp_idx=qp_idx)
msg_received = server.mr.read(server.msg_size, read_offset)
u.validate(msg_received, True, server.msg_size)
client.check_after_traffic()
class WqAttrs:
def __init__(self):
super().__init__()
self.wqe_num = 0
self.wqe_size = 0
self.wq_size = 0
self.head = 0
self.post_idx = 0
self.wqe_shift = 0
self.offset = 0
def __str__(self):
return str(vars(self))
def __format__(self, format_spec):
return str(self).__format__(format_spec)
class CqAttrs:
def __init__(self):
super().__init__()
self.cons_idx = 0
self.cqe_size = 64
self.ncqes = 256
def __str__(self):
return str(vars(self))
def __format__(self, format_spec):
return str(self).__format__(format_spec)
class QueueAttrs:
def __init__(self):
self.rq = WqAttrs()
self.sq = WqAttrs()
self.cq = CqAttrs()
def __str__(self):
print_format = '{}:\n\t{}\n'
return print_format.format('RQ Attributes', self.rq) + \
print_format.format('SQ Attributes', self.sq) + \
print_format.format('CQ Attributes', self.cq)
class Mlx5DevxRcResources(BaseResources):
"""
Creates all the DevX resources needed for a traffic-ready RC DevX QP,
including methods to transit the WQs into RTS state.
It also includes traffic methods for post send/receive and poll.
The class currently supports post send with immediate, but can be
easily extended to support other opcodes in the future.
"""
def __init__(self, dev_name, ib_port, gid_index, msg_size=1024, activate_port_state=False,
send_dbr_mode=0):
from tests.mlx5_prm_structs import SendDbrMode
super().__init__(dev_name, ib_port, gid_index)
self.umems = {}
self.send_dbr_mode = send_dbr_mode
self.msg_size = msg_size
self.num_msgs = 1000
self.imm = 0x03020100
self.uar = {}
self.max_recv_sge = 1
self.eqn = None
self.pd = None
self.dv_pd = None
self.mr = None
self.msi_vector = None
self.eq = None
self.cq = None
self.qp = None
self.qpn = None
self.psn = None
self.lid = None
self.gid = [0, 0, 0, 0]
# Remote attrs
self.rqpn = None
self.rpsn = None
self.rlid = None
self.rgid = [0, 0, 0, 0]
self.rmac = None
self.devx_objs = []
self.qattr = QueueAttrs()
if activate_port_state:
start_state_t = time.perf_counter()
self.change_port_state_with_registers(PortStatus.MLX5_PORT_UP)
admin_status, oper_status = self.query_port_state_with_registers()
while admin_status != PortStatus.MLX5_PORT_UP or oper_status != PortStatus.MLX5_PORT_UP:
if time.perf_counter() - start_state_t >= PORT_STATE_TIMEOUT:
raise PyverbsRDMAError('Could not change the port state to UP')
self.change_port_state_with_registers(PortStatus.MLX5_PORT_UP)
admin_status, oper_status = self.query_port_state_with_registers()
time.sleep(1)
mad_port_state = self.query_port_state_with_mads(ib_port)
while mad_port_state < PortState.ACTIVE:
if time.perf_counter() - start_state_t >= PORT_STATE_TIMEOUT:
raise PyverbsRDMAError('Could not change the port state to UP')
time.sleep(1)
mad_port_state = self.query_port_state_with_mads(ib_port)
if self.send_dbr_mode != SendDbrMode.DBR_VALID:
self.check_cap_send_dbr_mode()
self.init_resources()
def get_wqe_data_segment(self):
return WqeDataSeg(self.mr.length, self.mr.lkey, self.mr.buf)
def change_port_state_with_registers(self, state):
from tests.mlx5_prm_structs import PaosReg
paos_in = PaosReg(local_port=self.ib_port, admin_status=state, ase=1)
self.access_paos_register(paos_in)
def query_port_state_with_registers(self):
from tests.mlx5_prm_structs import PaosReg
paos_in = PaosReg(local_port=self.ib_port)
paos_out = self.access_paos_register(paos_in)
return paos_out.admin_status, paos_out.oper_status
def access_paos_register(self, paos_in, op_mod=0): # op_mod: 0 - write / 1 - read
from tests.mlx5_prm_structs import AccessPaosRegisterIn, \
AccessPaosRegisterOut, DevxOps
paos_reg_in = AccessPaosRegisterIn(op_mod=op_mod,
register_id=DevxOps.MLX5_CMD_OP_ACCESS_REGISTER_PAOS,
data=paos_in)
cmd_out = self.ctx.devx_general_cmd(paos_reg_in, len(AccessPaosRegisterOut()))
paos_reg_out = AccessPaosRegisterOut(cmd_out)
if paos_reg_out.status:
raise PyverbsRDMAError(f'Failed to access PAOS register ({paos_reg_out.syndrome})')
return paos_reg_out.data
def query_port_state_with_mads(self, ib_port):
from tests.mlx5_prm_structs import IbSmp
in_mad = IbSmp(base_version=1, mgmt_class=IB_MGMT_CLASS_SUBN_LID_ROUTED,
class_version=1, method=IB_MGMT_METHOD_GET,
attr_id=IB_SMP_ATTR_PORT_INFO, attr_mod=ib_port)
ib_smp_out = IbSmp(self._send_mad_cmd(ib_port, in_mad, 0x3))
return ib_smp_out.data[32] & 0xf
def _send_mad_cmd(self, ib_port, in_mad, op_mod):
from tests.mlx5_prm_structs import MadIfcIn, MadIfcOut
mad_ifc_in = MadIfcIn(op_mod=op_mod, port=ib_port, mad=in_mad)
cmd_out = self.ctx.devx_general_cmd(mad_ifc_in, len(MadIfcOut()))
mad_ifc_out = MadIfcOut(cmd_out)
if mad_ifc_out.status:
raise PyverbsRDMAError(f'Failed to send MAD with syndrome ({mad_ifc_out.syndrome})')
return mad_ifc_out.mad
def check_cap_send_dbr_mode(self):
"""
Check the capability of the dbr less.
If the HCA cap have HCA cap 2, check if in HCA cap2 0x20(HCA CAP 2) + 0x1(current)
have the send_dbr_mode_no_dbr_ext.
"""
from tests.mlx5_prm_structs import QueryCmdHcaCap2Out, \
QueryHcaCapIn, QueryCmdHcaCapOut, QueryHcaCapOp, QueryHcaCapMod, SendDbrMode
self.create_context()
query_cap_in = QueryHcaCapIn(op_mod=0x1)
query_cap_out = QueryCmdHcaCapOut(self.ctx.devx_general_cmd(
query_cap_in, len(QueryCmdHcaCapOut())))
if query_cap_out.status:
raise PyverbsRDMAError('Failed to query general HCA CAPs with syndrome '
f'({query_cap_out.syndrome}')
if not query_cap_out.capability.hca_cap_2:
raise unittest.SkipTest("The device doesn't support general HCA CAPs 2")
query_cap2_in = QueryHcaCapIn(op_mod=(QueryHcaCapOp.HCA_CAP_2 << 0x1) | \
QueryHcaCapMod.CURRENT)
query_cap2_out = QueryCmdHcaCap2Out(self.ctx.devx_general_cmd(
query_cap2_in, len(QueryCmdHcaCap2Out())))
if self.send_dbr_mode == SendDbrMode.NO_DBR_EXT and \
not query_cap2_out.capability.send_dbr_mode_no_dbr_ext:
raise unittest.SkipTest("The device doesn't support send_dbr_mode_no_dbr_ext cap")
if self.send_dbr_mode == SendDbrMode.NO_DBR_INT and \
not query_cap2_out.capability.send_dbr_mode_no_dbr_int:
raise unittest.SkipTest("The device doesn't support send_dbr_mode_no_dbr_int cap")
def init_resources(self):
if not self.is_eth():
self.query_lid()
else:
is_gid_available(self.gid_index)
self.query_gid()
self.create_pd()
self.create_mr()
self.query_eqn()
self.create_uar()
self.create_queue_attrs()
self.create_eq()
self.create_cq()
self.create_qp()
# Objects closure order is important, and must be done manually in DevX
self.devx_objs = [self.qp, self.cq] + list(self.uar.values()) + list(self.umems.values()) + [self.msi_vector, self.eq]
def query_lid(self):
from tests.mlx5_prm_structs import QueryHcaVportContextIn, \
QueryHcaVportContextOut, QueryHcaCapIn, QueryCmdHcaCapOut
query_cap_in = QueryHcaCapIn(op_mod=0x1)
query_cap_out = QueryCmdHcaCapOut(self.ctx.devx_general_cmd(
query_cap_in, len(QueryCmdHcaCapOut())))
if query_cap_out.status:
raise PyverbsRDMAError('Failed to query general HCA CAPs with syndrome '
f'({query_cap_out.syndrome}')
port_num = self.ib_port if query_cap_out.capability.num_ports >= 2 else 0
query_port_in = QueryHcaVportContextIn(port_num=port_num)
query_port_out = QueryHcaVportContextOut(self.ctx.devx_general_cmd(
query_port_in, len(QueryHcaVportContextOut())))
if query_port_out.status:
raise PyverbsRDMAError('Failed to query vport with syndrome '
f'({query_port_out.syndrome})')
self.lid = query_port_out.hca_vport_context.lid
def query_gid(self):
gid = self.ctx.query_gid(self.ib_port, self.gid_index).gid.split(':')
for i in range(0, len(gid), 2):
self.gid[int(i/2)] = int(gid[i] + gid[i+1], 16)
def is_eth(self):
from tests.mlx5_prm_structs import QueryHcaCapIn, \
QueryCmdHcaCapOut
query_cap_in = QueryHcaCapIn(op_mod=0x1)
query_cap_out = QueryCmdHcaCapOut(self.ctx.devx_general_cmd(
query_cap_in, len(QueryCmdHcaCapOut())))
if query_cap_out.status:
raise PyverbsRDMAError('Failed to query general HCA CAPs with syndrome '
f'({query_cap_out.syndrome})')
return query_cap_out.capability.port_type # 0:IB, 1:ETH
@staticmethod
def roundup_pow_of_two(val):
return pow(2, math.ceil(math.log2(val)))
def create_queue_attrs(self):
# RQ calculations
wqe_size = WqeDataSeg.sizeof() * self.max_recv_sge
self.qattr.rq.wqe_size = self.roundup_pow_of_two(wqe_size)
max_recv_wr = self.roundup_pow_of_two(self.num_msgs)
self.qattr.rq.wq_size = max(self.qattr.rq.wqe_size * max_recv_wr,
dve.MLX5_SEND_WQE_BB)
self.qattr.rq.wqe_num = math.ceil(self.qattr.rq.wq_size / self.qattr.rq.wqe_size)
self.qattr.rq.wqe_shift = int(math.log2(self.qattr.rq.wqe_size - 1)) + 1
# SQ calculations
self.qattr.sq.offset = self.qattr.rq.wq_size
# 192 = max overhead size of all structs needed for all operations in RC
wqe_size = 192 + WqeDataSeg.sizeof()
# Align wqe size to MLX5_SEND_WQE_BB
self.qattr.sq.wqe_size = (wqe_size + dve.MLX5_SEND_WQE_BB - 1) & ~(dve.MLX5_SEND_WQE_BB - 1)
self.qattr.sq.wq_size = self.roundup_pow_of_two(self.qattr.sq.wqe_size * self.num_msgs)
self.qattr.sq.wqe_num = math.ceil(self.qattr.sq.wq_size / dve.MLX5_SEND_WQE_BB)
self.qattr.sq.wqe_shift = int(math.log2(dve.MLX5_SEND_WQE_BB))
def create_context(self):
try:
attr = Mlx5DVContextAttr(dve.MLX5DV_CONTEXT_FLAGS_DEVX)
self.ctx = Mlx5Context(attr, self.dev_name)
except PyverbsUserError as ex:
raise unittest.SkipTest(f'Could not open mlx5 context ({ex})')
except PyverbsRDMAError:
raise unittest.SkipTest('Opening mlx5 DevX context is not supported')
def create_pd(self):
self.pd = PD(self.ctx)
self.dv_pd = Mlx5DvObj(dve.MLX5DV_OBJ_PD, pd=self.pd).dvpd
def create_mr(self):
access = e.IBV_ACCESS_REMOTE_WRITE | e.IBV_ACCESS_LOCAL_WRITE | \
e.IBV_ACCESS_REMOTE_READ
self.mr = MR(self.pd, self.msg_size, access)
def create_umem(self, size,
access=e.IBV_ACCESS_LOCAL_WRITE,
alignment=resource.getpagesize()):
return Mlx5UMEM(self.ctx, size=size, alignment=alignment, access=access)
def create_uar(self):
self.uar['qp'] = Mlx5UAR(self.ctx, dve._MLX5DV_UAR_ALLOC_TYPE_NC)
self.uar['cq'] = Mlx5UAR(self.ctx, dve._MLX5DV_UAR_ALLOC_TYPE_NC)
if not self.uar['cq'].page_id or not self.uar['qp'].page_id:
raise PyverbsRDMAError('Failed to allocate UAR')
def query_eqn(self):
self.eqn = self.ctx.devx_query_eqn(0)
def create_cq(self):
from tests.mlx5_prm_structs import CreateCqIn, SwCqc, CreateCqOut
cq_size = self.roundup_pow_of_two(self.qattr.cq.cqe_size * self.qattr.cq.ncqes)
# Align to page size
pg_size = resource.getpagesize()
cq_size = (cq_size + pg_size - 1) & ~(pg_size - 1)
self.umems['cq'] = self.create_umem(size=cq_size)
self.umems['cq_dbr'] = self.create_umem(size=8, alignment=8)
log_cq_size = math.ceil(math.log2(self.qattr.cq.ncqes))
cmd_in = CreateCqIn(cq_umem_valid=1, cq_umem_id=self.umems['cq'].umem_id,
sw_cqc=SwCqc(c_eqn=self.eqn, uar_page=self.uar['cq'].page_id,
log_cq_size=log_cq_size, dbr_umem_valid=1,
dbr_umem_id=self.umems['cq_dbr'].umem_id))
self.cq = Mlx5DevxObj(self.ctx, cmd_in, len(CreateCqOut()))
def create_qp(self):
self.psn = random.getrandbits(24)
from tests.mlx5_prm_structs import SwQpc, CreateQpIn, DevxOps,\
CreateQpOut, CreateCqOut
self.psn = random.getrandbits(24)
qp_size = self.roundup_pow_of_two(self.qattr.rq.wq_size + self.qattr.sq.wq_size)
# Align to page size
pg_size = resource.getpagesize()
qp_size = (qp_size + pg_size - 1) & ~(pg_size - 1)
self.umems['qp'] = self.create_umem(size=qp_size)
self.umems['qp_dbr'] = self.create_umem(size=8, alignment=8)
log_rq_size = int(math.log2(self.qattr.rq.wqe_num - 1)) + 1
# Size of a receive WQE is 16*pow(2, log_rq_stride)
log_rq_stride = self.qattr.rq.wqe_shift - 4
log_sq_size = int(math.log2(self.qattr.sq.wqe_num - 1)) + 1
cqn = CreateCqOut(self.cq.out_view).cqn
qpc = SwQpc(st=DevxOps.MLX5_QPC_ST_RC, pd=self.dv_pd.pdn,
pm_state=DevxOps.MLX5_QPC_PM_STATE_MIGRATED,
log_rq_size=log_rq_size, log_sq_size=log_sq_size, ts_format=0x1,
log_rq_stride=log_rq_stride, uar_page=self.uar['qp'].page_id,
cqn_snd=cqn, cqn_rcv=cqn, dbr_umem_id=self.umems['qp_dbr'].umem_id,
dbr_umem_valid=1, send_dbr_mode=self.send_dbr_mode)
cmd_in = CreateQpIn(sw_qpc=qpc, wq_umem_id=self.umems['qp'].umem_id,
wq_umem_valid=1)
self.qp = Mlx5DevxObj(self.ctx, cmd_in, len(CreateQpOut()))
self.qpn = CreateQpOut(self.qp.out_view).qpn
def create_eq(self):
pass
def to_rts(self):
"""
Moves the created QP to RTS state by modifying it using DevX through all
the needed states with all the required attributes.
rlid, rpsn, rqpn and rgid (when valid) must be already updated before
calling this method.
"""
from tests.mlx5_prm_structs import DevxOps, ModifyQpIn, ModifyQpOut,\
CreateQpOut, SwQpc
cmd_out_len = len(ModifyQpOut())
# RST2INIT
qpn = CreateQpOut(self.qp.out_view).qpn
swqpc = SwQpc(rre=1, rwe=1)
swqpc.primary_address_path.vhca_port_num = self.ib_port
cmd_in = ModifyQpIn(opcode=DevxOps.MLX5_CMD_OP_RST2INIT_QP, qpn=qpn,
sw_qpc=swqpc)
self.qp.modify(cmd_in, cmd_out_len)
# INIT2RTR
swqpc = SwQpc(mtu=PATH_MTU, log_msg_max=20, remote_qpn=self.rqpn,
min_rnr_nak=MIN_RNR_TIMER, next_rcv_psn=self.rpsn)
swqpc.primary_address_path.vhca_port_num = self.ib_port
swqpc.primary_address_path.rlid = self.rlid
if self.is_eth():
# GID field is a must for Eth (or if GRH is set in IB)
swqpc.primary_address_path.rgid_rip = self.rgid
swqpc.primary_address_path.rmac = self.rmac
swqpc.primary_address_path.src_addr_index = self.gid_index
swqpc.primary_address_path.hop_limit = tests.utils.PacketConsts.TTL_HOP_LIMIT
# UDP sport must be reserved for roce v1 and v1.5
if self.ctx.query_gid_type(self.ib_port, self.gid_index) == e.IBV_GID_TYPE_SYSFS_ROCE_V2:
swqpc.primary_address_path.udp_sport = 0xdcba
else:
swqpc.primary_address_path.rlid = self.rlid
cmd_in = ModifyQpIn(opcode=DevxOps.MLX5_CMD_OP_INIT2RTR_QP, qpn=qpn,
sw_qpc=swqpc)
self.qp.modify(cmd_in, cmd_out_len)
# RTR2RTS
swqpc = SwQpc(retry_count=RETRY_CNT, rnr_retry=RNR_RETRY,
next_send_psn=self.psn, log_sra_max=MAX_RDMA_ATOMIC)
swqpc.primary_address_path.vhca_port_num = self.ib_port
swqpc.primary_address_path.ack_timeout = TIMEOUT
cmd_in = ModifyQpIn(opcode=DevxOps.MLX5_CMD_OP_RTR2RTS_QP, qpn=qpn,
sw_qpc=swqpc)
self.qp.modify(cmd_in, cmd_out_len)
def pre_run(self, rpsn, rqpn, rgid=0, rlid=0, rmac=0):
"""
Configure Resources before running traffic
:param rpsns: Remote PSN (packet serial number)
:param rqpn: Remote QP number
:param rgid: Remote GID
:param rlid: Remote LID
:param rmac: Remote MAC (valid for RoCE)
:return: None
"""
self.rpsn = rpsn
self.rqpn = rqpn
self.rgid = rgid
self.rlid = rlid
self.rmac = rmac
self.to_rts()
def post_send(self):
"""
Posts one send WQE to the SQ by doing all the required work such as
building the control/data segments, updating and ringing the dbr,
updating the producer indexes, etc.
"""
from tests.mlx5_prm_structs import SendDbrMode
buffer_address = self.uar['qp'].reg_addr
if self.send_dbr_mode == SendDbrMode.NO_DBR_EXT:
# Address of DB blueflame register
buffer_address = self.uar['qp'].base_addr + DB_BF_DBR_LESS_BUF_OFFSET
idx = self.qattr.sq.post_idx if self.qattr.sq.post_idx < self.qattr.sq.wqe_num else 0
buf_offset = self.qattr.sq.offset + (idx << dve.MLX5_SEND_WQE_SHIFT)
# Prepare WQE
imm_be32 = struct.unpack("<I", struct.pack(">I", self.imm + self.qattr.sq.post_idx))[0]
ctrl_seg = WqeCtrlSeg(imm=imm_be32, fm_ce_se=dve.MLX5_WQE_CTRL_CQ_UPDATE)
data_seg = self.get_wqe_data_segment()
ctrl_seg.opmod_idx_opcode = (self.qattr.sq.post_idx & 0xffff) << 8 | dve.MLX5_OPCODE_SEND_IMM
size_in_octowords = int((ctrl_seg.sizeof() + data_seg.sizeof()) / 16)
ctrl_seg.qpn_ds = self.qpn << 8 | size_in_octowords
Wqe([ctrl_seg, data_seg], self.umems['qp'].umem_addr + buf_offset)
self.qattr.sq.post_idx += int((size_in_octowords * 16 +
dve.MLX5_SEND_WQE_BB - 1) / dve.MLX5_SEND_WQE_BB)
# Make sure descriptors are written
dma.udma_to_dev_barrier()
if not self.send_dbr_mode:
# Update the doorbell record
mem.writebe32(self.umems['qp_dbr'].umem_addr,
self.qattr.sq.post_idx & 0xffff, dve.MLX5_SND_DBR)
dma.udma_to_dev_barrier()
# Ring the doorbell and post the WQE
dma.mmio_write64_as_be(buffer_address, mem.read64(ctrl_seg.addr))
def post_recv(self):
"""
Posts one receive WQE to the RQ by doing all the required work such as
building the control/data segments, updating the dbr and the producer
indexes.
"""
buf_offset = self.qattr.rq.offset + self.qattr.rq.wqe_size * self.qattr.rq.head
# Prepare WQE
data_seg = self.get_wqe_data_segment()
Wqe([data_seg], self.umems['qp'].umem_addr + buf_offset)
# Update indexes
self.qattr.rq.post_idx += 1
self.qattr.rq.head = self.qattr.rq.head + 1 if self.qattr.rq.head + 1 < self.qattr.rq.wqe_num else 0
# Update the doorbell record
dma.udma_to_dev_barrier()
mem.writebe32(self.umems['qp_dbr'].umem_addr,
self.qattr.rq.post_idx & 0xffff, dve.MLX5_RCV_DBR)
def poll_cq(self):
"""
Polls the CQ once and updates the consumer index upon success.
The CQE opcode and owner bit are checked and verified.
This method does busy-waiting as long as it gets an empty CQE, until a
timeout of POLL_CQ_TIMEOUT seconds.
"""
idx = self.qattr.cq.cons_idx % self.qattr.cq.ncqes
cq_owner_flip = not(not(self.qattr.cq.cons_idx & self.qattr.cq.ncqes))
cqe_start_addr = self.umems['cq'].umem_addr + (idx * self.qattr.cq.cqe_size)
cqe = None
start_poll_t = time.perf_counter()
while cqe is None:
cqe = Mlx5Cqe64(cqe_start_addr)
if (cqe.opcode == dve.MLX5_CQE_INVALID) or \
(cqe.owner ^ cq_owner_flip) or cqe.is_empty():
if time.perf_counter() - start_poll_t >= POLL_CQ_TIMEOUT:
raise PyverbsRDMAError(f'CQE #{self.qattr.cq.cons_idx} '
f'is empty or invalid:\n{cqe.dump()}')
cqe = None
# After CQE ownership check, must do memory barrier and re-read the CQE.
dma.udma_from_dev_barrier()
cqe = Mlx5Cqe64(cqe_start_addr)
if cqe.opcode == dve.MLX5_CQE_RESP_ERR:
raise PyverbsRDMAError(f'Got a CQE #{self.qattr.cq.cons_idx} '
f'with responder error:\n{cqe.dump()}')
elif cqe.opcode == dve.MLX5_CQE_REQ_ERR:
raise PyverbsRDMAError(f'Got a CQE #{self.qattr.cq.cons_idx} '
f'with requester error:\n{cqe.dump()}')
self.qattr.cq.cons_idx += 1
mem.writebe32(self.umems['cq_dbr'].umem_addr,
self.qattr.cq.cons_idx & 0xffffff, MLX5_CQ_SET_CI)
return cqe
def close_resources(self):
for obj in self.devx_objs:
if obj:
obj.close()
class Mlx5DevxTrafficBase(Mlx5RDMATestCase):
"""
A base class for mlx5 DevX traffic tests.
This class does not include any tests, but provides quick players (client,
server) creation and provides a traffic method.
"""
def tearDown(self):
if self.server:
self.server.close_resources()
if self.client:
self.client.close_resources()
super().tearDown()
def create_players(self, resources, **resource_arg):
"""
Initialize tests resources.
:param resources: The RDMA resources to use.
:param resource_arg: Dictionary of args that specify the resources
specific attributes.
:return: None
"""
self.server = resources(**self.dev_info, **resource_arg)
self.client = resources(**self.dev_info, **resource_arg)
self.pre_run()
def pre_run(self):
self.server.pre_run(self.client.psn, self.client.qpn, self.client.gid,
self.client.lid, self.mac_addr)
self.client.pre_run(self.server.psn, self.server.qpn, self.server.gid,
self.server.lid, self.mac_addr)
def send_imm_traffic(self):
self.client.mem_write('c' * self.client.msg_size, self.client.msg_size)
for _ in range(self.client.num_msgs):
cons_idx = self.client.qattr.cq.cons_idx
self.server.post_recv()
self.client.post_send()
# Poll client and verify received cqe opcode
send_cqe = self.client.poll_cq()
self.assertEqual(send_cqe.opcode, dve.MLX5_CQE_REQ,
'Unexpected CQE opcode')
# Poll server and verify received cqe opcode
recv_cqe = self.server.poll_cq()
self.assertEqual(recv_cqe.opcode, dve.MLX5_CQE_RESP_SEND_IMM,
'Unexpected CQE opcode')
msg_received = self.server.mem_read()
# Validate data (of received message and immediate value)
tests.utils.validate(msg_received, True, self.server.msg_size)
imm_inval_pkey = recv_cqe.imm_inval_pkey
if sys.byteorder == 'big':
imm_inval_pkey = int.from_bytes(
imm_inval_pkey.to_bytes(4, byteorder='big'), 'little')
self.assertEqual(imm_inval_pkey, self.client.imm + cons_idx)
self.server.mem_write('s' * self.server.msg_size, self.server.msg_size)
class Mlx5RcResources(RCResources):
def __init__(self, dev_name, ib_port, gid_index, **kwargs):
self.dv_send_ops_flags = 0
self.send_ops_flags = 0
self.create_send_ops_flags()
super().__init__(dev_name, ib_port, gid_index, **kwargs)
def create_send_ops_flags(self):
self.dv_send_ops_flags = 0
self.send_ops_flags = e.IBV_QP_EX_WITH_SEND
def create_context(self):
mlx5dv_attr = Mlx5DVContextAttr()
try:
self.ctx = Mlx5Context(mlx5dv_attr, name=self.dev_name)
except PyverbsUserError as ex:
raise unittest.SkipTest(f'Could not open mlx5 context ({ex})')
except PyverbsRDMAError:
raise unittest.SkipTest('Opening mlx5 context is not supported')
def create_qp_init_attr(self):
comp_mask = e.IBV_QP_INIT_ATTR_PD | e.IBV_QP_INIT_ATTR_SEND_OPS_FLAGS
return QPInitAttrEx(cap=self.create_qp_cap(), pd=self.pd, scq=self.cq,
rcq=self.cq, qp_type=e.IBV_QPT_RC,
send_ops_flags=self.send_ops_flags,
comp_mask=comp_mask)
def create_qps(self):
try:
qp_init_attr = self.create_qp_init_attr()
comp_mask = dve.MLX5DV_QP_INIT_ATTR_MASK_QP_CREATE_FLAGS
if self.dv_send_ops_flags:
comp_mask |= dve.MLX5DV_QP_INIT_ATTR_MASK_SEND_OPS_FLAGS
attr = Mlx5DVQPInitAttr(comp_mask=comp_mask,
send_ops_flags=self.dv_send_ops_flags)
qp = Mlx5QP(self.ctx, qp_init_attr, attr)
self.qps.append(qp)
self.qps_num.append(qp.qp_num)
self.psns.append(random.getrandbits(24))
except PyverbsRDMAError as ex:
if ex.error_code == errno.EOPNOTSUPP:
raise unittest.SkipTest('Create Mlx5DV QP is not supported')
raise ex
def create_cq(self):
"""
Initializes self.cq with a dv_cq
:return: None
"""
dvcq_init_attr = Mlx5DVCQInitAttr()
try:
self.cq = Mlx5CQ(self.ctx, CqInitAttrEx(), dvcq_init_attr)
except PyverbsRDMAError as ex:
if ex.error_code == errno.EOPNOTSUPP:
raise unittest.SkipTest('Create Mlx5DV CQ is not supported')
raise ex
```
|
```php
<?php
/*
*
* File ini bagian dari:
*
* OpenSID
*
* Sistem informasi desa sumber terbuka untuk memajukan desa
*
* Aplikasi dan source code ini dirilis berdasarkan lisensi GPL V3
*
* Hak Cipta 2009 - 2015 Combine Resource Institution (path_to_url
* Hak Cipta 2016 - 2024 Perkumpulan Desa Digital Terbuka (path_to_url
*
* Dengan ini diberikan izin, secara gratis, kepada siapa pun yang mendapatkan salinan
* dari perangkat lunak ini dan file dokumentasi terkait ("Aplikasi Ini"), untuk diperlakukan
* tanpa batasan, termasuk hak untuk menggunakan, menyalin, mengubah dan/atau mendistribusikan,
* asal tunduk pada syarat berikut:
*
* Pemberitahuan hak cipta di atas dan pemberitahuan izin ini harus disertakan dalam
* setiap salinan atau bagian penting Aplikasi Ini. Barang siapa yang menghapus atau menghilangkan
* pemberitahuan ini melanggar ketentuan lisensi Aplikasi Ini.
*
* PERANGKAT LUNAK INI DISEDIAKAN "SEBAGAIMANA ADANYA", TANPA JAMINAN APA PUN, BAIK TERSURAT MAUPUN
* TERSIRAT. PENULIS ATAU PEMEGANG HAK CIPTA SAMA SEKALI TIDAK BERTANGGUNG JAWAB ATAS KLAIM, KERUSAKAN ATAU
* KEWAJIBAN APAPUN ATAS PENGGUNAAN ATAU LAINNYA TERKAIT APLIKASI INI.
*
* @package OpenSID
* @author Tim Pengembang OpenDesa
* @copyright Hak Cipta 2009 - 2015 Combine Resource Institution (path_to_url
* @copyright Hak Cipta 2016 - 2024 Perkumpulan Desa Digital Terbuka (path_to_url
* @license path_to_url GPL V3
* @link path_to_url
*
*/
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class () extends Migration {
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('log_login', static function (Blueprint $table) {
$table->char('uuid', 36)->primary();
$table->integer('config_id')->index('log_login_config_id_foreign');
$table->string('username');
$table->string('ip_address');
$table->string('user_agent');
$table->string('referer');
$table->string('lainnya')->nullable();
$table->timestamps();
$table->unique(['uuid', 'config_id']);
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::dropIfExists('log_login');
}
};
```
|
Tom B. Rosenberg (1947/1948) is an American film producer, co-founder of Beacon Pictures; and founder and chairman of Lakeshore Entertainment. He is a recipient of the 2004 Academy Award for Best Picture for the film Million Dollar Baby.
Biography
Rosenberg grew up on the North Side of Chicago. His father was an alderman of the 44th ward and later served as a Cook County judge. His mother worked in a dress shop and died when Rosenberg was 15. He had one sister who was 15 years his senior. He graduated from Lake View High School and then graduated from the University of Wisconsin at Madison. He then went on to teach at public schools in Chicago and then move to California where he went to the University of California at Berkeley Law School. He then moved to Willow Springs, Missouri where he worked as a lawyer, sold real estate, and helped to build subsidized housing for the elderly. After five years and newly divorced, he moved back to Chicago founded Capital Associates in 1977 with a partner. They built their first development in Decatur, Illinois. Rosenberg went on to build 54 buildings in Illinois, oversaw the largest school construction program in Chicago, and was active in fundraising for mayors Jane Byrne and Richard M. Daley. In 1984, he ran the Midwestern campaign for presidential candidate Walter Mondale. In 1989, he started a film company, Beacon Pictures, with his friend Armyan Bernstein; and their first film was released in 1991, The Commitments, directed by Alan Parker.
In 2004, he sold his real estate assets.
Filmography
He was a producer in all films unless otherwise noted.
Film
Television
Thanks
References
External links
Film producers from Illinois
Living people
Businesspeople from Chicago
Producers who won the Best Picture Academy Award
University of Wisconsin–Madison alumni
Year of birth missing (living people)
American real estate businesspeople
American people of Jewish descent
American independent film production company founders
|
Jan Aas (14 January 1944 – 30 May 2016) was a Norwegian footballer who played as a left-winger for Fredrikstad FK and Sarpsborg FK, and was also capped three times for Norway.
Aas made his first-team debut for Fredrikstad as a 17-year-old in 1961, and played six matches in FFK's title-winning 1960–61 season, and also won the Norwegian Cup the same year. He made his international debut for Norway in a friendly against Finland on 26 August 1962. He left Fredrikstad in 1969 and played briefly for Swedish team Bengtsfors IF, before returning to Norwegian football when he joined Sarpsborg in 1971. At Sarpsborg, Aas won two more international caps.
After three seasons with Sarpsborg, Aas returned to Fredrikstad ahead of the 1974 season, and helped FFK return to the top flight after the club's first-ever relegation the year before. He played for Fredrikstad until his retirement from the game in 1978. He returned to FFK as coach in 1984, but was sacked midway through the season following a string of poor results.
Aas died on 30 May 2016, aged 72.
References
1944 births
2016 deaths
Norwegian men's footballers
Norwegian expatriate men's footballers
Norway men's international footballers
Norwegian expatriate sportspeople in Sweden
Expatriate men's footballers in Sweden
Fredrikstad FK players
Sarpsborg FK players
Men's association football midfielders
Footballers from Fredrikstad
|
```php
<?php
/*
*
*
* path_to_url
*
* Unless required by applicable law or agreed to in writing, software
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
*/
namespace Google\Service\Dfareporting;
class MobileCarrier extends \Google\Model
{
/**
* @var string
*/
public $countryCode;
/**
* @var string
*/
public $countryDartId;
/**
* @var string
*/
public $id;
/**
* @var string
*/
public $kind;
/**
* @var string
*/
public $name;
/**
* @param string
*/
public function setCountryCode($countryCode)
{
$this->countryCode = $countryCode;
}
/**
* @return string
*/
public function getCountryCode()
{
return $this->countryCode;
}
/**
* @param string
*/
public function setCountryDartId($countryDartId)
{
$this->countryDartId = $countryDartId;
}
/**
* @return string
*/
public function getCountryDartId()
{
return $this->countryDartId;
}
/**
* @param string
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
/**
* @param string
*/
public function setKind($kind)
{
$this->kind = $kind;
}
/**
* @return string
*/
public function getKind()
{
return $this->kind;
}
/**
* @param string
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(MobileCarrier::class, 'Google_Service_Dfareporting_MobileCarrier');
```
|
```objective-c
#pragma once
#include "ihopdirective.h"
#include <vector>
namespace mbus {
/**
* A hop is basically an instantiated {@link HopBlueprint}, but it can also be contructed using the factory method
* {@link this#parse(String)}. It is a set of primitives, either a string primitive that is to be matched verbatim to a
* service address, or a {@link RoutingPolicy} directive.
*/
class Hop {
private:
std::vector<IHopDirective::SP> _selector;
bool _ignoreResult;
public:
/**
* Convenience typedef for an auto-pointer to a hop.
*/
using UP = std::unique_ptr<Hop>;
/**
* Constructs an empty hop.
*/
Hop();
/**
* Constructs a new hop based on a selector string.
*
* @param selector The selector string for this hop.
*/
Hop(const string &selector);
/**
* Constructs a fully populated hop.
*
* @param selector The selector to copy.
* @param ignoreResult Whether or not to ignore the result of this hop.
*/
Hop(std::vector<IHopDirective::SP> selector, bool ignoreResult);
Hop(const Hop &);
Hop & operator = (const Hop &);
Hop(Hop &&) noexcept = default;
Hop & operator = (Hop &&) noexcept = default;
~Hop();
/**
* Adds a new directive to this hop.
*
* @param directive The directive to add.
* @return This, to allow chaining.
*/
Hop &addDirective(IHopDirective::SP dir);
/**
* Returns whether or not there are any directives contained in this hop.
*
* @return True if there is at least one directive.
*/
bool hasDirectives() const { return !_selector.empty(); }
/**
* Returns the number of directives contained in this hop.
*
* @return The number of directives.
*/
uint32_t getNumDirectives() const { return _selector.size(); }
/**
* Returns the directive at the given index.
*
* @param i The index of the directive to return.
* @return The item.
*/
const IHopDirective & getDirective(uint32_t i) const { return *_selector[i]; }
IHopDirective::SP getDirectiveSP(uint32_t i) const { return _selector[i]; }
/**
* Sets the directive at a given index.
*
* @param i The index at which to set the directive.
* @param dir The directive to set.
* @return This, to allow chaining.
*/
Hop &setDirective(uint32_t i, IHopDirective::SP dir);
/**
* Returns the service name referenced by this hop. This is the concatenation of all selector primitives,
* but with no ignore-result prefix.
*
* @return The service name.
*/
string getServiceName() const { return toString(0, _selector.size()); }
/**
* Returns whether or not to ignore the result when routing through this hop.
*
* @return True to ignore the result.
*/
bool getIgnoreResult() const { return _ignoreResult; }
/**
* Sets whether or not to ignore the result when routing through this hop.
*
* @param ignoreResult Whether or not to ignore the result.
* @return This, to allow chaining.
*/
Hop &setIgnoreResult(bool ignoreResult) {
_ignoreResult = ignoreResult;
return *this;
}
/**
* Parses the given string as a single hop. The {@link this#toString()} method is compatible with this parser.
*
* @param hop The string to parse.
* @return A hop that corresponds to the string.
*/
static Hop parse(const string &hop);
/**
* Returns true whether this hop matches another. This respects policy directives matching any other.
*
* @param hop The hop to compare to.
* @return True if this matches the argument, false otherwise.
*/
bool matches(const Hop &hop) const;
/**
* Returns a string representation of this that can be debugged but not parsed.
*
* @return The debug string.
*/
string toDebugString() const;
/**
* Returns a string representation of this that can be parsed.
*
* @return The parseable string.
*/
string toString() const;
/**
* Returns a string concatenation of a subset of the selector primitives contained in this.
*
* @param fromIncluding The index of the first primitive to include.
* @param toNotIncluding The index after the last primitive to include.
* @return The string concatenation.
*/
string toString(uint32_t fromIncluding, uint32_t toNotIncluding) const;
/**
* Returns the prefix of this hop's selector to, but not including, the given index.
*
* @param toNotIncluding The index to which to generate prefix.
* @return The prefix before the index.
*/
string getPrefix(uint32_t toNotIncluding) const;
/**
* Returns the suffix of this hop's selector from, but not including, the given index.
*
* @param fromNotIncluding The index from which to generate suffix.
* @return The suffix after the index.
*/
string getSuffix(uint32_t fromNotIncluding) const;
};
} // namespace mbus
```
|
```smalltalk
using System.Linq;
using Algorithms.Strings;
using Algorithms.Strings.PatternMatching;
using NUnit.Framework;
namespace Algorithms.Tests.Strings;
public static class NaiveStringSearchTests
{
[Test]
public static void ThreeMatchesFound_PassExpected()
{
// Arrange
var pattern = "ABB";
var content = "ABBBAAABBAABBBBAB";
// Act
var expectedOccurrences = new[] { 0, 6, 10 };
var actualOccurrences = NaiveStringSearch.NaiveSearch(content, pattern);
var sequencesAreEqual = expectedOccurrences.SequenceEqual(actualOccurrences);
// Assert
Assert.That(sequencesAreEqual, Is.True);
}
[Test]
public static void OneMatchFound_PassExpected()
{
// Arrange
var pattern = "BAAB";
var content = "ABBBAAABBAABBBBAB";
// Act
var expectedOccurrences = new[] { 8 };
var actualOccurrences = NaiveStringSearch.NaiveSearch(content, pattern);
var sequencesAreEqual = expectedOccurrences.SequenceEqual(actualOccurrences);
// Assert
Assert.That(sequencesAreEqual, Is.True);
}
[Test]
public static void NoMatchFound_PassExpected()
{
// Arrange
var pattern = "XYZ";
var content = "ABBBAAABBAABBBBAB";
// Act
var expectedOccurrences = new int[0];
var actualOccurrences = NaiveStringSearch.NaiveSearch(content, pattern);
var sequencesAreEqual = expectedOccurrences.SequenceEqual(actualOccurrences);
// Assert
Assert.That(sequencesAreEqual, Is.True);
}
}
```
|
```html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML>
<HEAD>
<TITLE>Lua 5.4 Reference Manual</TITLE>
<LINK REL="stylesheet" TYPE="text/css" HREF="lua.css">
<LINK REL="stylesheet" TYPE="text/css" HREF="manual.css">
<META HTTP-EQUIV="content-type" CONTENT="text/html; charset=iso-8859-1">
</HEAD>
<BODY>
<H1>
<A HREF="path_to_url"><IMG SRC="logo.gif" ALT="Lua"></A>
Lua 5.4 Reference Manual
</H1>
<P>
by Roberto Ierusalimschy, Luiz Henrique de Figueiredo, Waldemar Celes
<P>
<SMALL>
Freely available under the terms of the
<a href="path_to_url">Lua license</a>.
</SMALL>
<DIV CLASS="menubar">
<A HREF="contents.html#contents">contents</A>
·
<A HREF="contents.html#index">index</A>
·
<A HREF="path_to_url">other versions</A>
</DIV>
<!-- ====================================================================== -->
<p>
<!-- $Id: manual.of $ -->
<h1>1 – <a name="1">Introduction</a></h1>
<p>
Lua is a powerful, efficient, lightweight, embeddable scripting language.
It supports procedural programming,
object-oriented programming, functional programming,
data-driven programming, and data description.
<p>
Lua combines simple procedural syntax with powerful data description
constructs based on associative arrays and extensible semantics.
Lua is dynamically typed,
runs by interpreting bytecode with a register-based
virtual machine,
and has automatic memory management with
a generational garbage collection,
making it ideal for configuration, scripting,
and rapid prototyping.
<p>
Lua is implemented as a library, written in <em>clean C</em>,
the common subset of Standard C and C++.
The Lua distribution includes a host program called <code>lua</code>,
which uses the Lua library to offer a complete,
standalone Lua interpreter,
for interactive or batch use.
Lua is intended to be used both as a powerful, lightweight,
embeddable scripting language for any program that needs one,
and as a powerful but lightweight and efficient stand-alone language.
<p>
As an extension language, Lua has no notion of a "main" program:
it works <em>embedded</em> in a host client,
called the <em>embedding program</em> or simply the <em>host</em>.
(Frequently, this host is the stand-alone <code>lua</code> program.)
The host program can invoke functions to execute a piece of Lua code,
can write and read Lua variables,
and can register C functions to be called by Lua code.
Through the use of C functions, Lua can be augmented to cope with
a wide range of different domains,
thus creating customized programming languages sharing a syntactical framework.
<p>
Lua is free software,
and is provided as usual with no guarantees,
as stated in its license.
The implementation described in this manual is available
at Lua's official web site, <code>www.lua.org</code>.
<p>
Like any other reference manual,
this document is dry in places.
For a discussion of the decisions behind the design of Lua,
see the technical papers available at Lua's web site.
For a detailed introduction to programming in Lua,
see Roberto's book, <em>Programming in Lua</em>.
<h1>2 – <a name="2">Basic Concepts</a></h1>
<p>
This section describes the basic concepts of the language.
<h2>2.1 – <a name="2.1">Values and Types</a></h2>
<p>
Lua is a dynamically typed language.
This means that
variables do not have types; only values do.
There are no type definitions in the language.
All values carry their own type.
<p>
All values in Lua are first-class values.
This means that all values can be stored in variables,
passed as arguments to other functions, and returned as results.
<p>
There are eight basic types in Lua:
<em>nil</em>, <em>boolean</em>, <em>number</em>,
<em>string</em>, <em>function</em>, <em>userdata</em>,
<em>thread</em>, and <em>table</em>.
The type <em>nil</em> has one single value, <b>nil</b>,
whose main property is to be different from any other value;
it often represents the absence of a useful value.
The type <em>boolean</em> has two values, <b>false</b> and <b>true</b>.
Both <b>nil</b> and <b>false</b> make a condition false;
they are collectively called <em>false values</em>.
Any other value makes a condition true.
Despite its name,
<b>false</b> is frequently used as an alternative to <b>nil</b>,
with the key difference that <b>false</b> behaves
like a regular value in a table,
while a <b>nil</b> in a table represents an absent key.
<p>
The type <em>number</em> represents both
integer numbers and real (floating-point) numbers,
using two subtypes: <em>integer</em> and <em>float</em>.
Standard Lua uses 64-bit integers and double-precision (64-bit) floats,
but you can also compile Lua so that it
uses 32-bit integers and/or single-precision (32-bit) floats.
The option with 32 bits for both integers and floats
is particularly attractive
for small machines and embedded systems.
(See macro <code>LUA_32BITS</code> in file <code>luaconf.h</code>.)
<p>
Unless stated otherwise,
any overflow when manipulating integer values <em>wrap around</em>,
according to the usual rules of two-complement arithmetic.
(In other words,
the actual result is the unique representable integer
that is equal modulo <em>2<sup>n</sup></em> to the mathematical result,
where <em>n</em> is the number of bits of the integer type.)
<p>
Lua has explicit rules about when each subtype is used,
but it also converts between them automatically as needed (see <a href="#3.4.3">§3.4.3</a>).
Therefore,
the programmer may choose to mostly ignore the difference
between integers and floats
or to assume complete control over the representation of each number.
<p>
The type <em>string</em> represents immutable sequences of bytes.
Lua is 8-bit clean:
strings can contain any 8-bit value,
including embedded zeros ('<code>\0</code>').
Lua is also encoding-agnostic;
it makes no assumptions about the contents of a string.
The length of any string in Lua must fit in a Lua integer.
<p>
Lua can call (and manipulate) functions written in Lua and
functions written in C (see <a href="#3.4.10">§3.4.10</a>).
Both are represented by the type <em>function</em>.
<p>
The type <em>userdata</em> is provided to allow arbitrary C data to
be stored in Lua variables.
A userdata value represents a block of raw memory.
There are two kinds of userdata:
<em>full userdata</em>,
which is an object with a block of memory managed by Lua,
and <em>light userdata</em>,
which is simply a C pointer value.
Userdata has no predefined operations in Lua,
except assignment and identity test.
By using <em>metatables</em>,
the programmer can define operations for full userdata values
(see <a href="#2.4">§2.4</a>).
Userdata values cannot be created or modified in Lua,
only through the C API.
This guarantees the integrity of data owned by
the host program and C libraries.
<p>
The type <em>thread</em> represents independent threads of execution
and it is used to implement coroutines (see <a href="#2.6">§2.6</a>).
Lua threads are not related to operating-system threads.
Lua supports coroutines on all systems,
even those that do not support threads natively.
<p>
The type <em>table</em> implements associative arrays,
that is, arrays that can have as indices not only numbers,
but any Lua value except <b>nil</b> and NaN.
(<em>Not a Number</em> is a special floating-point value
used by the IEEE 754 standard to represent
undefined numerical results, such as <code>0/0</code>.)
Tables can be <em>heterogeneous</em>;
that is, they can contain values of all types (except <b>nil</b>).
Any key associated to the value <b>nil</b> is not considered part of the table.
Conversely, any key that is not part of a table has
an associated value <b>nil</b>.
<p>
Tables are the sole data-structuring mechanism in Lua;
they can be used to represent ordinary arrays, lists,
symbol tables, sets, records, graphs, trees, etc.
To represent records, Lua uses the field name as an index.
The language supports this representation by
providing <code>a.name</code> as syntactic sugar for <code>a["name"]</code>.
There are several convenient ways to create tables in Lua
(see <a href="#3.4.9">§3.4.9</a>).
<p>
Like indices,
the values of table fields can be of any type.
In particular,
because functions are first-class values,
table fields can contain functions.
Thus tables can also carry <em>methods</em> (see <a href="#3.4.11">§3.4.11</a>).
<p>
The indexing of tables follows
the definition of raw equality in the language.
The expressions <code>a[i]</code> and <code>a[j]</code>
denote the same table element
if and only if <code>i</code> and <code>j</code> are raw equal
(that is, equal without metamethods).
In particular, floats with integral values
are equal to their respective integers
(e.g., <code>1.0 == 1</code>).
To avoid ambiguities,
any float used as a key that is equal to an integer
is converted to that integer.
For instance, if you write <code>a[2.0] = true</code>,
the actual key inserted into the table will be the integer <code>2</code>.
<p>
Tables, functions, threads, and (full) userdata values are <em>objects</em>:
variables do not actually <em>contain</em> these values,
only <em>references</em> to them.
Assignment, parameter passing, and function returns
always manipulate references to such values;
these operations do not imply any kind of copy.
<p>
The library function <a href="#pdf-type"><code>type</code></a> returns a string describing the type
of a given value (see <a href="#pdf-type"><code>type</code></a>).
<h2>2.2 – <a name="2.2">Environments and the Global Environment</a></h2>
<p>
As we will discuss further in <a href="#3.2">§3.2</a> and <a href="#3.3.3">§3.3.3</a>,
any reference to a free name
(that is, a name not bound to any declaration) <code>var</code>
is syntactically translated to <code>_ENV.var</code>.
Moreover, every chunk is compiled in the scope of
an external local variable named <code>_ENV</code> (see <a href="#3.3.2">§3.3.2</a>),
so <code>_ENV</code> itself is never a free name in a chunk.
<p>
Despite the existence of this external <code>_ENV</code> variable and
the translation of free names,
<code>_ENV</code> is a completely regular name.
In particular,
you can define new variables and parameters with that name.
Each reference to a free name uses the <code>_ENV</code> that is
visible at that point in the program,
following the usual visibility rules of Lua (see <a href="#3.5">§3.5</a>).
<p>
Any table used as the value of <code>_ENV</code> is called an <em>environment</em>.
<p>
Lua keeps a distinguished environment called the <em>global environment</em>.
This value is kept at a special index in the C registry (see <a href="#4.3">§4.3</a>).
In Lua, the global variable <a href="#pdf-_G"><code>_G</code></a> is initialized with this same value.
(<a href="#pdf-_G"><code>_G</code></a> is never used internally,
so changing its value will affect only your own code.)
<p>
When Lua loads a chunk,
the default value for its <code>_ENV</code> variable
is the global environment (see <a href="#pdf-load"><code>load</code></a>).
Therefore, by default,
free names in Lua code refer to entries in the global environment
and, therefore, they are also called <em>global variables</em>.
Moreover, all standard libraries are loaded in the global environment
and some functions there operate on that environment.
You can use <a href="#pdf-load"><code>load</code></a> (or <a href="#pdf-loadfile"><code>loadfile</code></a>)
to load a chunk with a different environment.
(In C, you have to load the chunk and then change the value
of its first upvalue; see <a href="#lua_setupvalue"><code>lua_setupvalue</code></a>.)
<h2>2.3 – <a name="2.3">Error Handling</a></h2>
<p>
Several operations in Lua can <em>raise</em> an error.
An error interrupts the normal flow of the program,
which can continue by <em>catching</em> the error.
<p>
Lua code can explicitly raise an error by calling the
<a href="#pdf-error"><code>error</code></a> function.
(This function never returns.)
<p>
To catch errors in Lua,
you can do a <em>protected call</em>,
using <a href="#pdf-pcall"><code>pcall</code></a> (or <a href="#pdf-xpcall"><code>xpcall</code></a>).
The function <a href="#pdf-pcall"><code>pcall</code></a> calls a given function in <em>protected mode</em>.
Any error while running the function stops its execution,
and control returns immediately to <code>pcall</code>,
which returns a status code.
<p>
Because Lua is an embedded extension language,
Lua code starts running by a call
from C code in the host program.
(When you use Lua standalone,
the <code>lua</code> application is the host program.)
Usually, this call is protected;
so, when an otherwise unprotected error occurs during
the compilation or execution of a Lua chunk,
control returns to the host,
which can take appropriate measures,
such as printing an error message.
<p>
Whenever there is an error,
an <em>error object</em>
is propagated with information about the error.
Lua itself only generates errors whose error object is a string,
but programs may generate errors with
any value as the error object.
It is up to the Lua program or its host to handle such error objects.
For historical reasons,
an error object is often called an <em>error message</em>,
even though it does not have to be a string.
<p>
When you use <a href="#pdf-xpcall"><code>xpcall</code></a> (or <a href="#lua_pcall"><code>lua_pcall</code></a>, in C)
you may give a <em>message handler</em>
to be called in case of errors.
This function is called with the original error object
and returns a new error object.
It is called before the error unwinds the stack,
so that it can gather more information about the error,
for instance by inspecting the stack and creating a stack traceback.
This message handler is still protected by the protected call;
so, an error inside the message handler
will call the message handler again.
If this loop goes on for too long,
Lua breaks it and returns an appropriate message.
The message handler is called only for regular runtime errors.
It is not called for memory-allocation errors
nor for errors while running finalizers or other message handlers.
<p>
Lua also offers a system of <em>warnings</em> (see <a href="#pdf-warn"><code>warn</code></a>).
Unlike errors, warnings do not interfere
in any way with program execution.
They typically only generate a message to the user,
although this behavior can be adapted from C (see <a href="#lua_setwarnf"><code>lua_setwarnf</code></a>).
<h2>2.4 – <a name="2.4">Metatables and Metamethods</a></h2>
<p>
Every value in Lua can have a <em>metatable</em>.
This <em>metatable</em> is an ordinary Lua table
that defines the behavior of the original value
under certain events.
You can change several aspects of the behavior
of a value by setting specific fields in its metatable.
For instance, when a non-numeric value is the operand of an addition,
Lua checks for a function in the field <code>__add</code> of the value's metatable.
If it finds one,
Lua calls this function to perform the addition.
<p>
The key for each event in a metatable is a string
with the event name prefixed by two underscores;
the corresponding value is called a <em>metavalue</em>.
For most events, the metavalue must be a function,
which is then called a <em>metamethod</em>.
In the previous example, the key is the string "<code>__add</code>"
and the metamethod is the function that performs the addition.
Unless stated otherwise,
a metamethod may in fact be any callable value,
which is either a function or a value with a <code>__call</code> metamethod.
<p>
You can query the metatable of any value
using the <a href="#pdf-getmetatable"><code>getmetatable</code></a> function.
Lua queries metamethods in metatables using a raw access (see <a href="#pdf-rawget"><code>rawget</code></a>).
<p>
You can replace the metatable of tables
using the <a href="#pdf-setmetatable"><code>setmetatable</code></a> function.
You cannot change the metatable of other types from Lua code,
except by using the debug library (<a href="#6.10">§6.10</a>).
<p>
Tables and full userdata have individual metatables,
although multiple tables and userdata can share their metatables.
Values of all other types share one single metatable per type;
that is, there is one single metatable for all numbers,
one for all strings, etc.
By default, a value has no metatable,
but the string library sets a metatable for the string type (see <a href="#6.4">§6.4</a>).
<p>
A detailed list of operations controlled by metatables is given next.
Each event is identified by its corresponding key.
By convention, all metatable keys used by Lua are composed by
two underscores followed by lowercase Latin letters.
<ul>
<li><b><code>__add</code>: </b>
the addition (<code>+</code>) operation.
If any operand for an addition is not a number,
Lua will try to call a metamethod.
It starts by checking the first operand (even if it is a number);
if that operand does not define a metamethod for <code>__add</code>,
then Lua will check the second operand.
If Lua can find a metamethod,
it calls the metamethod with the two operands as arguments,
and the result of the call
(adjusted to one value)
is the result of the operation.
Otherwise, if no metamethod is found,
Lua raises an error.
</li>
<li><b><code>__sub</code>: </b>
the subtraction (<code>-</code>) operation.
Behavior similar to the addition operation.
</li>
<li><b><code>__mul</code>: </b>
the multiplication (<code>*</code>) operation.
Behavior similar to the addition operation.
</li>
<li><b><code>__div</code>: </b>
the division (<code>/</code>) operation.
Behavior similar to the addition operation.
</li>
<li><b><code>__mod</code>: </b>
the modulo (<code>%</code>) operation.
Behavior similar to the addition operation.
</li>
<li><b><code>__pow</code>: </b>
the exponentiation (<code>^</code>) operation.
Behavior similar to the addition operation.
</li>
<li><b><code>__unm</code>: </b>
the negation (unary <code>-</code>) operation.
Behavior similar to the addition operation.
</li>
<li><b><code>__idiv</code>: </b>
the floor division (<code>//</code>) operation.
Behavior similar to the addition operation.
</li>
<li><b><code>__band</code>: </b>
the bitwise AND (<code>&</code>) operation.
Behavior similar to the addition operation,
except that Lua will try a metamethod
if any operand is neither an integer
nor a float coercible to an integer (see <a href="#3.4.3">§3.4.3</a>).
</li>
<li><b><code>__bor</code>: </b>
the bitwise OR (<code>|</code>) operation.
Behavior similar to the bitwise AND operation.
</li>
<li><b><code>__bxor</code>: </b>
the bitwise exclusive OR (binary <code>~</code>) operation.
Behavior similar to the bitwise AND operation.
</li>
<li><b><code>__bnot</code>: </b>
the bitwise NOT (unary <code>~</code>) operation.
Behavior similar to the bitwise AND operation.
</li>
<li><b><code>__shl</code>: </b>
the bitwise left shift (<code><<</code>) operation.
Behavior similar to the bitwise AND operation.
</li>
<li><b><code>__shr</code>: </b>
the bitwise right shift (<code>>></code>) operation.
Behavior similar to the bitwise AND operation.
</li>
<li><b><code>__concat</code>: </b>
the concatenation (<code>..</code>) operation.
Behavior similar to the addition operation,
except that Lua will try a metamethod
if any operand is neither a string nor a number
(which is always coercible to a string).
</li>
<li><b><code>__len</code>: </b>
the length (<code>#</code>) operation.
If the object is not a string,
Lua will try its metamethod.
If there is a metamethod,
Lua calls it with the object as argument,
and the result of the call
(always adjusted to one value)
is the result of the operation.
If there is no metamethod but the object is a table,
then Lua uses the table length operation (see <a href="#3.4.7">§3.4.7</a>).
Otherwise, Lua raises an error.
</li>
<li><b><code>__eq</code>: </b>
the equal (<code>==</code>) operation.
Behavior similar to the addition operation,
except that Lua will try a metamethod only when the values
being compared are either both tables or both full userdata
and they are not primitively equal.
The result of the call is always converted to a boolean.
</li>
<li><b><code>__lt</code>: </b>
the less than (<code><</code>) operation.
Behavior similar to the addition operation,
except that Lua will try a metamethod only when the values
being compared are neither both numbers nor both strings.
Moreover, the result of the call is always converted to a boolean.
</li>
<li><b><code>__le</code>: </b>
the less equal (<code><=</code>) operation.
Behavior similar to the less than operation.
</li>
<li><b><code>__index</code>: </b>
The indexing access operation <code>table[key]</code>.
This event happens when <code>table</code> is not a table or
when <code>key</code> is not present in <code>table</code>.
The metavalue is looked up in the metatable of <code>table</code>.
<p>
The metavalue for this event can be either a function, a table,
or any value with an <code>__index</code> metavalue.
If it is a function,
it is called with <code>table</code> and <code>key</code> as arguments,
and the result of the call
(adjusted to one value)
is the result of the operation.
Otherwise,
the final result is the result of indexing this metavalue with <code>key</code>.
This indexing is regular, not raw,
and therefore can trigger another <code>__index</code> metavalue.
</li>
<li><b><code>__newindex</code>: </b>
The indexing assignment <code>table[key] = value</code>.
Like the index event,
this event happens when <code>table</code> is not a table or
when <code>key</code> is not present in <code>table</code>.
The metavalue is looked up in the metatable of <code>table</code>.
<p>
Like with indexing,
the metavalue for this event can be either a function, a table,
or any value with an <code>__newindex</code> metavalue.
If it is a function,
it is called with <code>table</code>, <code>key</code>, and <code>value</code> as arguments.
Otherwise,
Lua repeats the indexing assignment over this metavalue
with the same key and value.
This assignment is regular, not raw,
and therefore can trigger another <code>__newindex</code> metavalue.
<p>
Whenever a <code>__newindex</code> metavalue is invoked,
Lua does not perform the primitive assignment.
If needed,
the metamethod itself can call <a href="#pdf-rawset"><code>rawset</code></a>
to do the assignment.
</li>
<li><b><code>__call</code>: </b>
The call operation <code>func(args)</code>.
This event happens when Lua tries to call a non-function value
(that is, <code>func</code> is not a function).
The metamethod is looked up in <code>func</code>.
If present,
the metamethod is called with <code>func</code> as its first argument,
followed by the arguments of the original call (<code>args</code>).
All results of the call
are the results of the operation.
This is the only metamethod that allows multiple results.
</li>
</ul>
<p>
In addition to the previous list,
the interpreter also respects the following keys in metatables:
<code>__gc</code> (see <a href="#2.5.3">§2.5.3</a>),
<code>__close</code> (see <a href="#3.3.8">§3.3.8</a>),
<code>__mode</code> (see <a href="#2.5.4">§2.5.4</a>),
and <code>__name</code>.
(The entry <code>__name</code>,
when it contains a string,
may be used by <a href="#pdf-tostring"><code>tostring</code></a> and in error messages.)
<p>
For the unary operators (negation, length, and bitwise NOT),
the metamethod is computed and called with a dummy second operand,
equal to the first one.
This extra operand is only to simplify Lua's internals
(by making these operators behave like a binary operation)
and may be removed in future versions.
For most uses this extra operand is irrelevant.
<p>
Because metatables are regular tables,
they can contain arbitrary fields,
not only the event names defined above.
Some functions in the standard library
(e.g., <a href="#pdf-tostring"><code>tostring</code></a>)
use other fields in metatables for their own purposes.
<p>
It is a good practice to add all needed metamethods to a table
before setting it as a metatable of some object.
In particular, the <code>__gc</code> metamethod works only when this order
is followed (see <a href="#2.5.3">§2.5.3</a>).
It is also a good practice to set the metatable of an object
right after its creation.
<h2>2.5 – <a name="2.5">Garbage Collection</a></h2>
<p>
Lua performs automatic memory management.
This means that
you do not have to worry about allocating memory for new objects
or freeing it when the objects are no longer needed.
Lua manages memory automatically by running
a <em>garbage collector</em> to collect all <em>dead</em> objects.
All memory used by Lua is subject to automatic management:
strings, tables, userdata, functions, threads, internal structures, etc.
<p>
An object is considered <em>dead</em>
as soon as the collector can be sure the object
will not be accessed again in the normal execution of the program.
("Normal execution" here excludes finalizers,
which can resurrect dead objects (see <a href="#2.5.3">§2.5.3</a>),
and excludes also operations using the debug library.)
Note that the time when the collector can be sure that an object
is dead may not coincide with the programmer's expectations.
The only guarantees are that Lua will not collect an object
that may still be accessed in the normal execution of the program,
and it will eventually collect an object
that is inaccessible from Lua.
(Here,
<em>inaccessible from Lua</em> means that neither a variable nor
another live object refer to the object.)
Because Lua has no knowledge about C code,
it never collects objects accessible through the registry (see <a href="#4.3">§4.3</a>),
which includes the global environment (see <a href="#2.2">§2.2</a>).
<p>
The garbage collector (GC) in Lua can work in two modes:
incremental and generational.
<p>
The default GC mode with the default parameters
are adequate for most uses.
However, programs that waste a large proportion of their time
allocating and freeing memory can benefit from other settings.
Keep in mind that the GC behavior is non-portable
both across platforms and across different Lua releases;
therefore, optimal settings are also non-portable.
<p>
You can change the GC mode and parameters by calling
<a href="#lua_gc"><code>lua_gc</code></a> in C
or <a href="#pdf-collectgarbage"><code>collectgarbage</code></a> in Lua.
You can also use these functions to control
the collector directly (e.g., to stop and restart it).
<h3>2.5.1 – <a name="2.5.1">Incremental Garbage Collection</a></h3>
<p>
In incremental mode,
each GC cycle performs a mark-and-sweep collection in small steps
interleaved with the program's execution.
In this mode,
the collector uses three numbers to control its garbage-collection cycles:
the <em>garbage-collector pause</em>,
the <em>garbage-collector step multiplier</em>,
and the <em>garbage-collector step size</em>.
<p>
The garbage-collector pause
controls how long the collector waits before starting a new cycle.
The collector starts a new cycle when the use of memory
hits <em>n%</em> of the use after the previous collection.
Larger values make the collector less aggressive.
Values equal to or less than 100 mean the collector will not wait to
start a new cycle.
A value of 200 means that the collector waits for the total memory in use
to double before starting a new cycle.
The default value is 200; the maximum value is 1000.
<p>
The garbage-collector step multiplier
controls the speed of the collector relative to
memory allocation,
that is,
how many elements it marks or sweeps for each
kilobyte of memory allocated.
Larger values make the collector more aggressive but also increase
the size of each incremental step.
You should not use values less than 100,
because they make the collector too slow and
can result in the collector never finishing a cycle.
The default value is 100; the maximum value is 1000.
<p>
The garbage-collector step size controls the
size of each incremental step,
specifically how many bytes the interpreter allocates
before performing a step.
This parameter is logarithmic:
A value of <em>n</em> means the interpreter will allocate <em>2<sup>n</sup></em>
bytes between steps and perform equivalent work during the step.
A large value (e.g., 60) makes the collector a stop-the-world
(non-incremental) collector.
The default value is 13,
which means steps of approximately 8 Kbytes.
<h3>2.5.2 – <a name="2.5.2">Generational Garbage Collection</a></h3>
<p>
In generational mode,
the collector does frequent <em>minor</em> collections,
which traverses only objects recently created.
If after a minor collection the use of memory is still above a limit,
the collector does a stop-the-world <em>major</em> collection,
which traverses all objects.
The generational mode uses two parameters:
the <em>minor multiplier</em> and the <em>the major multiplier</em>.
<p>
The minor multiplier controls the frequency of minor collections.
For a minor multiplier <em>x</em>,
a new minor collection will be done when memory
grows <em>x%</em> larger than the memory in use after the previous major
collection.
For instance, for a multiplier of 20,
the collector will do a minor collection when the use of memory
gets 20% larger than the use after the previous major collection.
The default value is 20; the maximum value is 200.
<p>
The major multiplier controls the frequency of major collections.
For a major multiplier <em>x</em>,
a new major collection will be done when memory
grows <em>x%</em> larger than the memory in use after the previous major
collection.
For instance, for a multiplier of 100,
the collector will do a major collection when the use of memory
gets larger than twice the use after the previous collection.
The default value is 100; the maximum value is 1000.
<h3>2.5.3 – <a name="2.5.3">Garbage-Collection Metamethods</a></h3>
<p>
You can set garbage-collector metamethods for tables
and, using the C API,
for full userdata (see <a href="#2.4">§2.4</a>).
These metamethods, called <em>finalizers</em>,
are called when the garbage collector detects that the
corresponding table or userdata is dead.
Finalizers allow you to coordinate Lua's garbage collection
with external resource management such as closing files,
network or database connections,
or freeing your own memory.
<p>
For an object (table or userdata) to be finalized when collected,
you must <em>mark</em> it for finalization.
You mark an object for finalization when you set its metatable
and the metatable has a <code>__gc</code> metamethod.
Note that if you set a metatable without a <code>__gc</code> field
and later create that field in the metatable,
the object will not be marked for finalization.
<p>
When a marked object becomes dead,
it is not collected immediately by the garbage collector.
Instead, Lua puts it in a list.
After the collection,
Lua goes through that list.
For each object in the list,
it checks the object's <code>__gc</code> metamethod:
If it is present,
Lua calls it with the object as its single argument.
<p>
At the end of each garbage-collection cycle,
the finalizers are called in
the reverse order that the objects were marked for finalization,
among those collected in that cycle;
that is, the first finalizer to be called is the one associated
with the object marked last in the program.
The execution of each finalizer may occur at any point during
the execution of the regular code.
<p>
Because the object being collected must still be used by the finalizer,
that object (and other objects accessible only through it)
must be <em>resurrected</em> by Lua.
Usually, this resurrection is transient,
and the object memory is freed in the next garbage-collection cycle.
However, if the finalizer stores the object in some global place
(e.g., a global variable),
then the resurrection is permanent.
Moreover, if the finalizer marks a finalizing object for finalization again,
its finalizer will be called again in the next cycle where the
object is dead.
In any case,
the object memory is freed only in a GC cycle where
the object is dead and not marked for finalization.
<p>
When you close a state (see <a href="#lua_close"><code>lua_close</code></a>),
Lua calls the finalizers of all objects marked for finalization,
following the reverse order that they were marked.
If any finalizer marks objects for collection during that phase,
these marks have no effect.
<p>
Finalizers cannot yield.
Except for that, they can do anything,
such as raise errors, create new objects,
or even run the garbage collector.
However, because they can run in unpredictable times,
it is good practice to restrict each finalizer
to the minimum necessary to properly release
its associated resource.
<p>
Any error while running a finalizer generates a warning;
the error is not propagated.
<h3>2.5.4 – <a name="2.5.4">Weak Tables</a></h3>
<p>
A <em>weak table</em> is a table whose elements are
<em>weak references</em>.
A weak reference is ignored by the garbage collector.
In other words,
if the only references to an object are weak references,
then the garbage collector will collect that object.
<p>
A weak table can have weak keys, weak values, or both.
A table with weak values allows the collection of its values,
but prevents the collection of its keys.
A table with both weak keys and weak values allows the collection of
both keys and values.
In any case, if either the key or the value is collected,
the whole pair is removed from the table.
The weakness of a table is controlled by the
<code>__mode</code> field of its metatable.
This metavalue, if present, must be one of the following strings:
"<code>k</code>", for a table with weak keys;
"<code>v</code>", for a table with weak values;
or "<code>kv</code>", for a table with both weak keys and values.
<p>
A table with weak keys and strong values
is also called an <em>ephemeron table</em>.
In an ephemeron table,
a value is considered reachable only if its key is reachable.
In particular,
if the only reference to a key comes through its value,
the pair is removed.
<p>
Any change in the weakness of a table may take effect only
at the next collect cycle.
In particular, if you change the weakness to a stronger mode,
Lua may still collect some items from that table
before the change takes effect.
<p>
Only objects that have an explicit construction
are removed from weak tables.
Values, such as numbers and light C functions,
are not subject to garbage collection,
and therefore are not removed from weak tables
(unless their associated values are collected).
Although strings are subject to garbage collection,
they do not have an explicit construction and
their equality is by value;
they behave more like values than like objects.
Therefore, they are not removed from weak tables.
<p>
Resurrected objects
(that is, objects being finalized
and objects accessible only through objects being finalized)
have a special behavior in weak tables.
They are removed from weak values before running their finalizers,
but are removed from weak keys only in the next collection
after running their finalizers, when such objects are actually freed.
This behavior allows the finalizer to access properties
associated with the object through weak tables.
<p>
If a weak table is among the resurrected objects in a collection cycle,
it may not be properly cleared until the next cycle.
<h2>2.6 – <a name="2.6">Coroutines</a></h2>
<p>
Lua supports coroutines,
also called <em>collaborative multithreading</em>.
A coroutine in Lua represents an independent thread of execution.
Unlike threads in multithread systems, however,
a coroutine only suspends its execution by explicitly calling
a yield function.
<p>
You create a coroutine by calling <a href="#pdf-coroutine.create"><code>coroutine.create</code></a>.
Its sole argument is a function
that is the main function of the coroutine.
The <code>create</code> function only creates a new coroutine and
returns a handle to it (an object of type <em>thread</em>);
it does not start the coroutine.
<p>
You execute a coroutine by calling <a href="#pdf-coroutine.resume"><code>coroutine.resume</code></a>.
When you first call <a href="#pdf-coroutine.resume"><code>coroutine.resume</code></a>,
passing as its first argument
a thread returned by <a href="#pdf-coroutine.create"><code>coroutine.create</code></a>,
the coroutine starts its execution by
calling its main function.
Extra arguments passed to <a href="#pdf-coroutine.resume"><code>coroutine.resume</code></a> are passed
as arguments to that function.
After the coroutine starts running,
it runs until it terminates or <em>yields</em>.
<p>
A coroutine can terminate its execution in two ways:
normally, when its main function returns
(explicitly or implicitly, after the last instruction);
and abnormally, if there is an unprotected error.
In case of normal termination,
<a href="#pdf-coroutine.resume"><code>coroutine.resume</code></a> returns <b>true</b>,
plus any values returned by the coroutine main function.
In case of errors, <a href="#pdf-coroutine.resume"><code>coroutine.resume</code></a> returns <b>false</b>
plus the error object.
In this case, the coroutine does not unwind its stack,
so that it is possible to inspect it after the error
with the debug API.
<p>
A coroutine yields by calling <a href="#pdf-coroutine.yield"><code>coroutine.yield</code></a>.
When a coroutine yields,
the corresponding <a href="#pdf-coroutine.resume"><code>coroutine.resume</code></a> returns immediately,
even if the yield happens inside nested function calls
(that is, not in the main function,
but in a function directly or indirectly called by the main function).
In the case of a yield, <a href="#pdf-coroutine.resume"><code>coroutine.resume</code></a> also returns <b>true</b>,
plus any values passed to <a href="#pdf-coroutine.yield"><code>coroutine.yield</code></a>.
The next time you resume the same coroutine,
it continues its execution from the point where it yielded,
with the call to <a href="#pdf-coroutine.yield"><code>coroutine.yield</code></a> returning any extra
arguments passed to <a href="#pdf-coroutine.resume"><code>coroutine.resume</code></a>.
<p>
Like <a href="#pdf-coroutine.create"><code>coroutine.create</code></a>,
the <a href="#pdf-coroutine.wrap"><code>coroutine.wrap</code></a> function also creates a coroutine,
but instead of returning the coroutine itself,
it returns a function that, when called, resumes the coroutine.
Any arguments passed to this function
go as extra arguments to <a href="#pdf-coroutine.resume"><code>coroutine.resume</code></a>.
<a href="#pdf-coroutine.wrap"><code>coroutine.wrap</code></a> returns all the values returned by <a href="#pdf-coroutine.resume"><code>coroutine.resume</code></a>,
except the first one (the boolean error code).
Unlike <a href="#pdf-coroutine.resume"><code>coroutine.resume</code></a>,
the function created by <a href="#pdf-coroutine.wrap"><code>coroutine.wrap</code></a>
propagates any error to the caller.
In this case,
the function also closes the coroutine (see <a href="#pdf-coroutine.close"><code>coroutine.close</code></a>).
<p>
As an example of how coroutines work,
consider the following code:
<pre>
function foo (a)
print("foo", a)
return coroutine.yield(2*a)
end
co = coroutine.create(function (a,b)
print("co-body", a, b)
local r = foo(a+1)
print("co-body", r)
local r, s = coroutine.yield(a+b, a-b)
print("co-body", r, s)
return b, "end"
end)
print("main", coroutine.resume(co, 1, 10))
print("main", coroutine.resume(co, "r"))
print("main", coroutine.resume(co, "x", "y"))
print("main", coroutine.resume(co, "x", "y"))
</pre><p>
When you run it, it produces the following output:
<pre>
co-body 1 10
foo 2
main true 4
co-body r
main true 11 -9
co-body x y
main true 10 end
main false cannot resume dead coroutine
</pre>
<p>
You can also create and manipulate coroutines through the C API:
see functions <a href="#lua_newthread"><code>lua_newthread</code></a>, <a href="#lua_resume"><code>lua_resume</code></a>,
and <a href="#lua_yield"><code>lua_yield</code></a>.
<h1>3 – <a name="3">The Language</a></h1>
<p>
This section describes the lexis, the syntax, and the semantics of Lua.
In other words,
this section describes
which tokens are valid,
how they can be combined,
and what their combinations mean.
<p>
Language constructs will be explained using the usual extended BNF notation,
in which
{<em>a</em>} means 0 or more <em>a</em>'s, and
[<em>a</em>] means an optional <em>a</em>.
Non-terminals are shown like non-terminal,
keywords are shown like <b>kword</b>,
and other terminal symbols are shown like ‘<b>=</b>’.
The complete syntax of Lua can be found in <a href="#9">§9</a>
at the end of this manual.
<h2>3.1 – <a name="3.1">Lexical Conventions</a></h2>
<p>
Lua is a free-form language.
It ignores spaces and comments between lexical elements (tokens),
except as delimiters between two tokens.
In source code,
Lua recognizes as spaces the standard ASCII whitespace
characters space, form feed, newline,
carriage return, horizontal tab, and vertical tab.
<p>
<em>Names</em>
(also called <em>identifiers</em>)
in Lua can be any string of Latin letters,
Arabic-Indic digits, and underscores,
not beginning with a digit and
not being a reserved word.
Identifiers are used to name variables, table fields, and labels.
<p>
The following <em>keywords</em> are reserved
and cannot be used as names:
<pre>
and break do else elseif end
false for function goto if in
local nil not or repeat return
then true until while
</pre>
<p>
Lua is a case-sensitive language:
<code>and</code> is a reserved word, but <code>And</code> and <code>AND</code>
are two different, valid names.
As a convention,
programs should avoid creating
names that start with an underscore followed by
one or more uppercase letters (such as <a href="#pdf-_VERSION"><code>_VERSION</code></a>).
<p>
The following strings denote other tokens:
<pre>
+ - * / % ^ #
& ~ | << >> //
== ~= <= >= < > =
( ) { } [ ] ::
; : , . .. ...
</pre>
<p>
A <em>short literal string</em>
can be delimited by matching single or double quotes,
and can contain the following C-like escape sequences:
'<code>\a</code>' (bell),
'<code>\b</code>' (backspace),
'<code>\f</code>' (form feed),
'<code>\n</code>' (newline),
'<code>\r</code>' (carriage return),
'<code>\t</code>' (horizontal tab),
'<code>\v</code>' (vertical tab),
'<code>\\</code>' (backslash),
'<code>\"</code>' (quotation mark [double quote]),
and '<code>\'</code>' (apostrophe [single quote]).
A backslash followed by a line break
results in a newline in the string.
The escape sequence '<code>\z</code>' skips the following span
of whitespace characters,
including line breaks;
it is particularly useful to break and indent a long literal string
into multiple lines without adding the newlines and spaces
into the string contents.
A short literal string cannot contain unescaped line breaks
nor escapes not forming a valid escape sequence.
<p>
We can specify any byte in a short literal string,
including embedded zeros,
by its numeric value.
This can be done
with the escape sequence <code>\x<em>XX</em></code>,
where <em>XX</em> is a sequence of exactly two hexadecimal digits,
or with the escape sequence <code>\<em>ddd</em></code>,
where <em>ddd</em> is a sequence of up to three decimal digits.
(Note that if a decimal escape sequence is to be followed by a digit,
it must be expressed using exactly three digits.)
<p>
The UTF-8 encoding of a Unicode character
can be inserted in a literal string with
the escape sequence <code>\u{<em>XXX</em>}</code>
(with mandatory enclosing braces),
where <em>XXX</em> is a sequence of one or more hexadecimal digits
representing the character code point.
This code point can be any value less than <em>2<sup>31</sup></em>.
(Lua uses the original UTF-8 specification here,
which is not restricted to valid Unicode code points.)
<p>
Literal strings can also be defined using a long format
enclosed by <em>long brackets</em>.
We define an <em>opening long bracket of level <em>n</em></em> as an opening
square bracket followed by <em>n</em> equal signs followed by another
opening square bracket.
So, an opening long bracket of level 0 is written as <code>[[</code>,
an opening long bracket of level 1 is written as <code>[=[</code>,
and so on.
A <em>closing long bracket</em> is defined similarly;
for instance,
a closing long bracket of level 4 is written as <code>]====]</code>.
A <em>long literal</em> starts with an opening long bracket of any level and
ends at the first closing long bracket of the same level.
It can contain any text except a closing bracket of the same level.
Literals in this bracketed form can run for several lines,
do not interpret any escape sequences,
and ignore long brackets of any other level.
Any kind of end-of-line sequence
(carriage return, newline, carriage return followed by newline,
or newline followed by carriage return)
is converted to a simple newline.
When the opening long bracket is immediately followed by a newline,
the newline is not included in the string.
<p>
As an example, in a system using ASCII
(in which '<code>a</code>' is coded as 97,
newline is coded as 10, and '<code>1</code>' is coded as 49),
the five literal strings below denote the same string:
<pre>
a = 'alo\n123"'
a = "alo\n123\""
a = '\97lo\10\04923"'
a = [[alo
123"]]
a = [==[
alo
123"]==]
</pre>
<p>
Any byte in a literal string not
explicitly affected by the previous rules represents itself.
However, Lua opens files for parsing in text mode,
and the system's file functions may have problems with
some control characters.
So, it is safer to represent
binary data as a quoted literal with
explicit escape sequences for the non-text characters.
<p>
A <em>numeric constant</em> (or <em>numeral</em>)
can be written with an optional fractional part
and an optional decimal exponent,
marked by a letter '<code>e</code>' or '<code>E</code>'.
Lua also accepts hexadecimal constants,
which start with <code>0x</code> or <code>0X</code>.
Hexadecimal constants also accept an optional fractional part
plus an optional binary exponent,
marked by a letter '<code>p</code>' or '<code>P</code>'.
<p>
A numeric constant with a radix point or an exponent
denotes a float;
otherwise,
if its value fits in an integer or it is a hexadecimal constant,
it denotes an integer;
otherwise (that is, a decimal integer numeral that overflows),
it denotes a float.
Hexadecimal numerals with neither a radix point nor an exponent
always denote an integer value;
if the value overflows, it <em>wraps around</em>
to fit into a valid integer.
<p>
Examples of valid integer constants are
<pre>
3 345 0xff 0xBEBADA
</pre><p>
Examples of valid float constants are
<pre>
3.0 3.1416 314.16e-2 0.31416E1 34e1
0x0.1E 0xA23p-4 0X1.921FB54442D18P+1
</pre>
<p>
A <em>comment</em> starts with a double hyphen (<code>--</code>)
anywhere outside a string.
If the text immediately after <code>--</code> is not an opening long bracket,
the comment is a <em>short comment</em>,
which runs until the end of the line.
Otherwise, it is a <em>long comment</em>,
which runs until the corresponding closing long bracket.
<h2>3.2 – <a name="3.2">Variables</a></h2>
<p>
Variables are places that store values.
There are three kinds of variables in Lua:
global variables, local variables, and table fields.
<p>
A single name can denote a global variable or a local variable
(or a function's formal parameter,
which is a particular kind of local variable):
<pre>
var ::= Name
</pre><p>
Name denotes identifiers (see <a href="#3.1">§3.1</a>).
<p>
Any variable name is assumed to be global unless explicitly declared
as a local (see <a href="#3.3.7">§3.3.7</a>).
Local variables are <em>lexically scoped</em>:
local variables can be freely accessed by functions
defined inside their scope (see <a href="#3.5">§3.5</a>).
<p>
Before the first assignment to a variable, its value is <b>nil</b>.
<p>
Square brackets are used to index a table:
<pre>
var ::= prefixexp ‘<b>[</b>’ exp ‘<b>]</b>’
</pre><p>
The meaning of accesses to table fields can be changed via metatables
(see <a href="#2.4">§2.4</a>).
<p>
The syntax <code>var.Name</code> is just syntactic sugar for
<code>var["Name"]</code>:
<pre>
var ::= prefixexp ‘<b>.</b>’ Name
</pre>
<p>
An access to a global variable <code>x</code>
is equivalent to <code>_ENV.x</code>.
Due to the way that chunks are compiled,
the variable <code>_ENV</code> itself is never global (see <a href="#2.2">§2.2</a>).
<h2>3.3 – <a name="3.3">Statements</a></h2>
<p>
Lua supports an almost conventional set of statements,
similar to those in other conventional languages.
This set includes
blocks, assignments, control structures, function calls,
and variable declarations.
<h3>3.3.1 – <a name="3.3.1">Blocks</a></h3>
<p>
A block is a list of statements,
which are executed sequentially:
<pre>
block ::= {stat}
</pre><p>
Lua has <em>empty statements</em>
that allow you to separate statements with semicolons,
start a block with a semicolon
or write two semicolons in sequence:
<pre>
stat ::= ‘<b>;</b>’
</pre>
<p>
Both function calls and assignments
can start with an open parenthesis.
This possibility leads to an ambiguity in Lua's grammar.
Consider the following fragment:
<pre>
a = b + c
(print or io.write)('done')
</pre><p>
The grammar could see this fragment in two ways:
<pre>
a = b + c(print or io.write)('done')
a = b + c; (print or io.write)('done')
</pre><p>
The current parser always sees such constructions
in the first way,
interpreting the open parenthesis
as the start of the arguments to a call.
To avoid this ambiguity,
it is a good practice to always precede with a semicolon
statements that start with a parenthesis:
<pre>
;(print or io.write)('done')
</pre>
<p>
A block can be explicitly delimited to produce a single statement:
<pre>
stat ::= <b>do</b> block <b>end</b>
</pre><p>
Explicit blocks are useful
to control the scope of variable declarations.
Explicit blocks are also sometimes used to
add a <b>return</b> statement in the middle
of another block (see <a href="#3.3.4">§3.3.4</a>).
<h3>3.3.2 – <a name="3.3.2">Chunks</a></h3>
<p>
The unit of compilation of Lua is called a <em>chunk</em>.
Syntactically,
a chunk is simply a block:
<pre>
chunk ::= block
</pre>
<p>
Lua handles a chunk as the body of an anonymous function
with a variable number of arguments
(see <a href="#3.4.11">§3.4.11</a>).
As such, chunks can define local variables,
receive arguments, and return values.
Moreover, such anonymous function is compiled as in the
scope of an external local variable called <code>_ENV</code> (see <a href="#2.2">§2.2</a>).
The resulting function always has <code>_ENV</code> as its only external variable,
even if it does not use that variable.
<p>
A chunk can be stored in a file or in a string inside the host program.
To execute a chunk,
Lua first <em>loads</em> it,
precompiling the chunk's code into instructions for a virtual machine,
and then Lua executes the compiled code
with an interpreter for the virtual machine.
<p>
Chunks can also be precompiled into binary form;
see the program <code>luac</code> and the function <a href="#pdf-string.dump"><code>string.dump</code></a> for details.
Programs in source and compiled forms are interchangeable;
Lua automatically detects the file type and acts accordingly (see <a href="#pdf-load"><code>load</code></a>).
<h3>3.3.3 – <a name="3.3.3">Assignment</a></h3>
<p>
Lua allows multiple assignments.
Therefore, the syntax for assignment
defines a list of variables on the left side
and a list of expressions on the right side.
The elements in both lists are separated by commas:
<pre>
stat ::= varlist ‘<b>=</b>’ explist
varlist ::= var {‘<b>,</b>’ var}
explist ::= exp {‘<b>,</b>’ exp}
</pre><p>
Expressions are discussed in <a href="#3.4">§3.4</a>.
<p>
Before the assignment,
the list of values is <em>adjusted</em> to the length of
the list of variables.
If there are more values than needed,
the excess values are thrown away.
If there are fewer values than needed,
the list is extended with <b>nil</b>'s.
If the list of expressions ends with a function call,
then all values returned by that call enter the list of values,
before the adjustment
(except when the call is enclosed in parentheses; see <a href="#3.4">§3.4</a>).
<p>
The assignment statement first evaluates all its expressions
and only then the assignments are performed.
Thus the code
<pre>
i = 3
i, a[i] = i+1, 20
</pre><p>
sets <code>a[3]</code> to 20, without affecting <code>a[4]</code>
because the <code>i</code> in <code>a[i]</code> is evaluated (to 3)
before it is assigned 4.
Similarly, the line
<pre>
x, y = y, x
</pre><p>
exchanges the values of <code>x</code> and <code>y</code>,
and
<pre>
x, y, z = y, z, x
</pre><p>
cyclically permutes the values of <code>x</code>, <code>y</code>, and <code>z</code>.
<p>
An assignment to a global name <code>x = val</code>
is equivalent to the assignment
<code>_ENV.x = val</code> (see <a href="#2.2">§2.2</a>).
<p>
The meaning of assignments to table fields and
global variables (which are actually table fields, too)
can be changed via metatables (see <a href="#2.4">§2.4</a>).
<h3>3.3.4 – <a name="3.3.4">Control Structures</a></h3><p>
The control structures
<b>if</b>, <b>while</b>, and <b>repeat</b> have the usual meaning and
familiar syntax:
<pre>
stat ::= <b>while</b> exp <b>do</b> block <b>end</b>
stat ::= <b>repeat</b> block <b>until</b> exp
stat ::= <b>if</b> exp <b>then</b> block {<b>elseif</b> exp <b>then</b> block} [<b>else</b> block] <b>end</b>
</pre><p>
Lua also has a <b>for</b> statement, in two flavors (see <a href="#3.3.5">§3.3.5</a>).
<p>
The condition expression of a
control structure can return any value.
Both <b>false</b> and <b>nil</b> test false.
All values different from <b>nil</b> and <b>false</b> test true.
In particular, the number 0 and the empty string also test true.
<p>
In the <b>repeat</b>–<b>until</b> loop,
the inner block does not end at the <b>until</b> keyword,
but only after the condition.
So, the condition can refer to local variables
declared inside the loop block.
<p>
The <b>goto</b> statement transfers the program control to a label.
For syntactical reasons,
labels in Lua are considered statements too:
<pre>
stat ::= <b>goto</b> Name
stat ::= label
label ::= ‘<b>::</b>’ Name ‘<b>::</b>’
</pre>
<p>
A label is visible in the entire block where it is defined,
except inside nested functions.
A goto may jump to any visible label as long as it does not
enter into the scope of a local variable.
A label should not be declared
where a label with the same name is visible,
even if this other label has been declared in an enclosing block.
<p>
Labels and empty statements are called <em>void statements</em>,
as they perform no actions.
<p>
The <b>break</b> statement terminates the execution of a
<b>while</b>, <b>repeat</b>, or <b>for</b> loop,
skipping to the next statement after the loop:
<pre>
stat ::= <b>break</b>
</pre><p>
A <b>break</b> ends the innermost enclosing loop.
<p>
The <b>return</b> statement is used to return values
from a function or a chunk
(which is handled as an anonymous function).
Functions can return more than one value,
so the syntax for the <b>return</b> statement is
<pre>
stat ::= <b>return</b> [explist] [‘<b>;</b>’]
</pre>
<p>
The <b>return</b> statement can only be written
as the last statement of a block.
If it is necessary to <b>return</b> in the middle of a block,
then an explicit inner block can be used,
as in the idiom <code>do return end</code>,
because now <b>return</b> is the last statement in its (inner) block.
<h3>3.3.5 – <a name="3.3.5">For Statement</a></h3>
<p>
The <b>for</b> statement has two forms:
one numerical and one generic.
<h4>The numerical <b>for</b> loop</h4>
<p>
The numerical <b>for</b> loop repeats a block of code while a
control variable goes through an arithmetic progression.
It has the following syntax:
<pre>
stat ::= <b>for</b> Name ‘<b>=</b>’ exp ‘<b>,</b>’ exp [‘<b>,</b>’ exp] <b>do</b> block <b>end</b>
</pre><p>
The given identifier (Name) defines the control variable,
which is a new variable local to the loop body (<em>block</em>).
<p>
The loop starts by evaluating once the three control expressions.
Their values are called respectively
the <em>initial value</em>, the <em>limit</em>, and the <em>step</em>.
If the step is absent, it defaults to 1.
<p>
If both the initial value and the step are integers,
the loop is done with integers;
note that the limit may not be an integer.
Otherwise, the three values are converted to
floats and the loop is done with floats.
Beware of floating-point accuracy in this case.
<p>
After that initialization,
the loop body is repeated with the value of the control variable
going through an arithmetic progression,
starting at the initial value,
with a common difference given by the step.
A negative step makes a decreasing sequence;
a step equal to zero raises an error.
The loop continues while the value is less than
or equal to the limit
(greater than or equal to for a negative step).
If the initial value is already greater than the limit
(or less than, if the step is negative),
the body is not executed.
<p>
For integer loops,
the control variable never wraps around;
instead, the loop ends in case of an overflow.
<p>
You should not change the value of the control variable
during the loop.
If you need its value after the loop,
assign it to another variable before exiting the loop.
<h4>The generic <b>for</b> loop</h4>
<p>
The generic <b>for</b> statement works over functions,
called <em>iterators</em>.
On each iteration, the iterator function is called to produce a new value,
stopping when this new value is <b>nil</b>.
The generic <b>for</b> loop has the following syntax:
<pre>
stat ::= <b>for</b> namelist <b>in</b> explist <b>do</b> block <b>end</b>
namelist ::= Name {‘<b>,</b>’ Name}
</pre><p>
A <b>for</b> statement like
<pre>
for <em>var_1</em>, ···, <em>var_n</em> in <em>explist</em> do <em>body</em> end
</pre><p>
works as follows.
<p>
The names <em>var_i</em> declare loop variables local to the loop body.
The first of these variables is the <em>control variable</em>.
<p>
The loop starts by evaluating <em>explist</em>
to produce four values:
an <em>iterator function</em>,
a <em>state</em>,
an initial value for the control variable,
and a <em>closing value</em>.
<p>
Then, at each iteration,
Lua calls the iterator function with two arguments:
the state and the control variable.
The results from this call are then assigned to the loop variables,
following the rules of multiple assignments (see <a href="#3.3.3">§3.3.3</a>).
If the control variable becomes <b>nil</b>,
the loop terminates.
Otherwise, the body is executed and the loop goes
to the next iteration.
<p>
The closing value behaves like a
to-be-closed variable (see <a href="#3.3.8">§3.3.8</a>),
which can be used to release resources when the loop ends.
Otherwise, it does not interfere with the loop.
<p>
You should not change the value of the control variable
during the loop.
<h3>3.3.6 – <a name="3.3.6">Function Calls as Statements</a></h3><p>
To allow possible side-effects,
function calls can be executed as statements:
<pre>
stat ::= functioncall
</pre><p>
In this case, all returned values are thrown away.
Function calls are explained in <a href="#3.4.10">§3.4.10</a>.
<h3>3.3.7 – <a name="3.3.7">Local Declarations</a></h3><p>
Local variables can be declared anywhere inside a block.
The declaration can include an initialization:
<pre>
stat ::= <b>local</b> attnamelist [‘<b>=</b>’ explist]
attnamelist ::= Name attrib {‘<b>,</b>’ Name attrib}
</pre><p>
If present, an initial assignment has the same semantics
of a multiple assignment (see <a href="#3.3.3">§3.3.3</a>).
Otherwise, all variables are initialized with <b>nil</b>.
<p>
Each variable name may be postfixed by an attribute
(a name between angle brackets):
<pre>
attrib ::= [‘<b><</b>’ Name ‘<b>></b>’]
</pre><p>
There are two possible attributes:
<code>const</code>, which declares a constant variable,
that is, a variable that cannot be assigned to
after its initialization;
and <code>close</code>, which declares a to-be-closed variable (see <a href="#3.3.8">§3.3.8</a>).
A list of variables can contain at most one to-be-closed variable.
<p>
A chunk is also a block (see <a href="#3.3.2">§3.3.2</a>),
and so local variables can be declared in a chunk outside any explicit block.
<p>
The visibility rules for local variables are explained in <a href="#3.5">§3.5</a>.
<h3>3.3.8 – <a name="3.3.8">To-be-closed Variables</a></h3>
<p>
A to-be-closed variable behaves like a constant local variable,
except that its value is <em>closed</em> whenever the variable
goes out of scope, including normal block termination,
exiting its block by <b>break</b>/<b>goto</b>/<b>return</b>,
or exiting by an error.
<p>
Here, to <em>close</em> a value means
to call its <code>__close</code> metamethod.
When calling the metamethod,
the value itself is passed as the first argument
and the error object that caused the exit (if any)
is passed as a second argument;
if there was no error, the second argument is <b>nil</b>.
<p>
The value assigned to a to-be-closed variable
must have a <code>__close</code> metamethod
or be a false value.
(<b>nil</b> and <b>false</b> are ignored as to-be-closed values.)
<p>
If several to-be-closed variables go out of scope at the same event,
they are closed in the reverse order that they were declared.
<p>
If there is any error while running a closing method,
that error is handled like an error in the regular code
where the variable was defined.
After an error,
the other pending closing methods will still be called.
<p>
If a coroutine yields and is never resumed again,
some variables may never go out of scope,
and therefore they will never be closed.
(These variables are the ones created inside the coroutine
and in scope at the point where the coroutine yielded.)
Similarly, if a coroutine ends with an error,
it does not unwind its stack,
so it does not close any variable.
In both cases,
you can either use finalizers
or call <a href="#pdf-coroutine.close"><code>coroutine.close</code></a> to close the variables.
However, if the coroutine was created
through <a href="#pdf-coroutine.wrap"><code>coroutine.wrap</code></a>,
then its corresponding function will close the coroutine
in case of errors.
<h2>3.4 – <a name="3.4">Expressions</a></h2>
<p>
The basic expressions in Lua are the following:
<pre>
exp ::= prefixexp
exp ::= <b>nil</b> | <b>false</b> | <b>true</b>
exp ::= Numeral
exp ::= LiteralString
exp ::= functiondef
exp ::= tableconstructor
exp ::= ‘<b>...</b>’
exp ::= exp binop exp
exp ::= unop exp
prefixexp ::= var | functioncall | ‘<b>(</b>’ exp ‘<b>)</b>’
</pre>
<p>
Numerals and literal strings are explained in <a href="#3.1">§3.1</a>;
variables are explained in <a href="#3.2">§3.2</a>;
function definitions are explained in <a href="#3.4.11">§3.4.11</a>;
function calls are explained in <a href="#3.4.10">§3.4.10</a>;
table constructors are explained in <a href="#3.4.9">§3.4.9</a>.
Vararg expressions,
denoted by three dots ('<code>...</code>'), can only be used when
directly inside a vararg function;
they are explained in <a href="#3.4.11">§3.4.11</a>.
<p>
Binary operators comprise arithmetic operators (see <a href="#3.4.1">§3.4.1</a>),
bitwise operators (see <a href="#3.4.2">§3.4.2</a>),
relational operators (see <a href="#3.4.4">§3.4.4</a>), logical operators (see <a href="#3.4.5">§3.4.5</a>),
and the concatenation operator (see <a href="#3.4.6">§3.4.6</a>).
Unary operators comprise the unary minus (see <a href="#3.4.1">§3.4.1</a>),
the unary bitwise NOT (see <a href="#3.4.2">§3.4.2</a>),
the unary logical <b>not</b> (see <a href="#3.4.5">§3.4.5</a>),
and the unary <em>length operator</em> (see <a href="#3.4.7">§3.4.7</a>).
<p>
Both function calls and vararg expressions can result in multiple values.
If a function call is used as a statement (see <a href="#3.3.6">§3.3.6</a>),
then its return list is adjusted to zero elements,
thus discarding all returned values.
If an expression is used as the last (or the only) element
of a list of expressions,
then no adjustment is made
(unless the expression is enclosed in parentheses).
In all other contexts,
Lua adjusts the result list to one element,
either discarding all values except the first one
or adding a single <b>nil</b> if there are no values.
<p>
Here are some examples:
<pre>
f() -- adjusted to 0 results
g(f(), x) -- f() is adjusted to 1 result
g(x, f()) -- g gets x plus all results from f()
a,b,c = f(), x -- f() is adjusted to 1 result (c gets nil)
a,b = ... -- a gets the first vararg argument, b gets
-- the second (both a and b can get nil if there
-- is no corresponding vararg argument)
a,b,c = x, f() -- f() is adjusted to 2 results
a,b,c = f() -- f() is adjusted to 3 results
return f() -- returns all results from f()
return ... -- returns all received vararg arguments
return x,y,f() -- returns x, y, and all results from f()
{f()} -- creates a list with all results from f()
{...} -- creates a list with all vararg arguments
{f(), nil} -- f() is adjusted to 1 result
</pre>
<p>
Any expression enclosed in parentheses always results in only one value.
Thus,
<code>(f(x,y,z))</code> is always a single value,
even if <code>f</code> returns several values.
(The value of <code>(f(x,y,z))</code> is the first value returned by <code>f</code>
or <b>nil</b> if <code>f</code> does not return any values.)
<h3>3.4.1 – <a name="3.4.1">Arithmetic Operators</a></h3><p>
Lua supports the following arithmetic operators:
<ul>
<li><b><code>+</code>: </b>addition</li>
<li><b><code>-</code>: </b>subtraction</li>
<li><b><code>*</code>: </b>multiplication</li>
<li><b><code>/</code>: </b>float division</li>
<li><b><code>//</code>: </b>floor division</li>
<li><b><code>%</code>: </b>modulo</li>
<li><b><code>^</code>: </b>exponentiation</li>
<li><b><code>-</code>: </b>unary minus</li>
</ul>
<p>
With the exception of exponentiation and float division,
the arithmetic operators work as follows:
If both operands are integers,
the operation is performed over integers and the result is an integer.
Otherwise, if both operands are numbers,
then they are converted to floats,
the operation is performed following the machine's rules
for floating-point arithmetic
(usually the IEEE 754 standard),
and the result is a float.
(The string library coerces strings to numbers in
arithmetic operations; see <a href="#3.4.3">§3.4.3</a> for details.)
<p>
Exponentiation and float division (<code>/</code>)
always convert their operands to floats
and the result is always a float.
Exponentiation uses the ISO C function <code>pow</code>,
so that it works for non-integer exponents too.
<p>
Floor division (<code>//</code>) is a division
that rounds the quotient towards minus infinity,
resulting in the floor of the division of its operands.
<p>
Modulo is defined as the remainder of a division
that rounds the quotient towards minus infinity (floor division).
<p>
In case of overflows in integer arithmetic,
all operations <em>wrap around</em>.
<h3>3.4.2 – <a name="3.4.2">Bitwise Operators</a></h3><p>
Lua supports the following bitwise operators:
<ul>
<li><b><code>&</code>: </b>bitwise AND</li>
<li><b><code>|</code>: </b>bitwise OR</li>
<li><b><code>~</code>: </b>bitwise exclusive OR</li>
<li><b><code>>></code>: </b>right shift</li>
<li><b><code><<</code>: </b>left shift</li>
<li><b><code>~</code>: </b>unary bitwise NOT</li>
</ul>
<p>
All bitwise operations convert its operands to integers
(see <a href="#3.4.3">§3.4.3</a>),
operate on all bits of those integers,
and result in an integer.
<p>
Both right and left shifts fill the vacant bits with zeros.
Negative displacements shift to the other direction;
displacements with absolute values equal to or higher than
the number of bits in an integer
result in zero (as all bits are shifted out).
<h3>3.4.3 – <a name="3.4.3">Coercions and Conversions</a></h3><p>
Lua provides some automatic conversions between some
types and representations at run time.
Bitwise operators always convert float operands to integers.
Exponentiation and float division
always convert integer operands to floats.
All other arithmetic operations applied to mixed numbers
(integers and floats) convert the integer operand to a float.
The C API also converts both integers to floats and
floats to integers, as needed.
Moreover, string concatenation accepts numbers as arguments,
besides strings.
<p>
In a conversion from integer to float,
if the integer value has an exact representation as a float,
that is the result.
Otherwise,
the conversion gets the nearest higher or
the nearest lower representable value.
This kind of conversion never fails.
<p>
The conversion from float to integer
checks whether the float has an exact representation as an integer
(that is, the float has an integral value and
it is in the range of integer representation).
If it does, that representation is the result.
Otherwise, the conversion fails.
<p>
Several places in Lua coerce strings to numbers when necessary.
In particular,
the string library sets metamethods that try to coerce
strings to numbers in all arithmetic operations.
If the conversion fails,
the library calls the metamethod of the other operand
(if present) or it raises an error.
Note that bitwise operators do not do this coercion.
<p>
Nonetheless, it is always a good practice not to rely on these
implicit coercions, as they are not always applied;
in particular, <code>"1"==1</code> is false and <code>"1"<1</code> raises an error
(see <a href="#3.4.4">§3.4.4</a>).
These coercions exist mainly for compatibility and may be removed
in future versions of the language.
<p>
A string is converted to an integer or a float
following its syntax and the rules of the Lua lexer.
The string may have also leading and trailing whitespaces and a sign.
All conversions from strings to numbers
accept both a dot and the current locale mark
as the radix character.
(The Lua lexer, however, accepts only a dot.)
If the string is not a valid numeral,
the conversion fails.
If necessary, the result of this first step is then converted
to a specific number subtype following the previous rules
for conversions between floats and integers.
<p>
The conversion from numbers to strings uses a
non-specified human-readable format.
To convert numbers to strings in any specific way,
use the function <a href="#pdf-string.format"><code>string.format</code></a>.
<h3>3.4.4 – <a name="3.4.4">Relational Operators</a></h3><p>
Lua supports the following relational operators:
<ul>
<li><b><code>==</code>: </b>equality</li>
<li><b><code>~=</code>: </b>inequality</li>
<li><b><code><</code>: </b>less than</li>
<li><b><code>></code>: </b>greater than</li>
<li><b><code><=</code>: </b>less or equal</li>
<li><b><code>>=</code>: </b>greater or equal</li>
</ul><p>
These operators always result in <b>false</b> or <b>true</b>.
<p>
Equality (<code>==</code>) first compares the type of its operands.
If the types are different, then the result is <b>false</b>.
Otherwise, the values of the operands are compared.
Strings are equal if they have the same byte content.
Numbers are equal if they denote the same mathematical value.
<p>
Tables, userdata, and threads
are compared by reference:
two objects are considered equal only if they are the same object.
Every time you create a new object
(a table, a userdata, or a thread),
this new object is different from any previously existing object.
A function is always equal to itself.
Functions with any detectable difference
(different behavior, different definition) are always different.
Functions created at different times but with no detectable differences
may be classified as equal or not
(depending on internal caching details).
<p>
You can change the way that Lua compares tables and userdata
by using the <code>__eq</code> metamethod (see <a href="#2.4">§2.4</a>).
<p>
Equality comparisons do not convert strings to numbers
or vice versa.
Thus, <code>"0"==0</code> evaluates to <b>false</b>,
and <code>t[0]</code> and <code>t["0"]</code> denote different
entries in a table.
<p>
The operator <code>~=</code> is exactly the negation of equality (<code>==</code>).
<p>
The order operators work as follows.
If both arguments are numbers,
then they are compared according to their mathematical values,
regardless of their subtypes.
Otherwise, if both arguments are strings,
then their values are compared according to the current locale.
Otherwise, Lua tries to call the <code>__lt</code> or the <code>__le</code>
metamethod (see <a href="#2.4">§2.4</a>).
A comparison <code>a > b</code> is translated to <code>b < a</code>
and <code>a >= b</code> is translated to <code>b <= a</code>.
<p>
Following the IEEE 754 standard,
the special value NaN is considered neither less than,
nor equal to, nor greater than any value, including itself.
<h3>3.4.5 – <a name="3.4.5">Logical Operators</a></h3><p>
The logical operators in Lua are
<b>and</b>, <b>or</b>, and <b>not</b>.
Like the control structures (see <a href="#3.3.4">§3.3.4</a>),
all logical operators consider both <b>false</b> and <b>nil</b> as false
and anything else as true.
<p>
The negation operator <b>not</b> always returns <b>false</b> or <b>true</b>.
The conjunction operator <b>and</b> returns its first argument
if this value is <b>false</b> or <b>nil</b>;
otherwise, <b>and</b> returns its second argument.
The disjunction operator <b>or</b> returns its first argument
if this value is different from <b>nil</b> and <b>false</b>;
otherwise, <b>or</b> returns its second argument.
Both <b>and</b> and <b>or</b> use short-circuit evaluation;
that is,
the second operand is evaluated only if necessary.
Here are some examples:
<pre>
10 or 20 --> 10
10 or error() --> 10
nil or "a" --> "a"
nil and 10 --> nil
false and error() --> false
false and nil --> false
false or nil --> nil
10 and 20 --> 20
</pre>
<h3>3.4.6 – <a name="3.4.6">Concatenation</a></h3><p>
The string concatenation operator in Lua is
denoted by two dots ('<code>..</code>').
If both operands are strings or numbers,
then the numbers are converted to strings
in a non-specified format (see <a href="#3.4.3">§3.4.3</a>).
Otherwise, the <code>__concat</code> metamethod is called (see <a href="#2.4">§2.4</a>).
<h3>3.4.7 – <a name="3.4.7">The Length Operator</a></h3>
<p>
The length operator is denoted by the unary prefix operator <code>#</code>.
<p>
The length of a string is its number of bytes.
(That is the usual meaning of string length when each
character is one byte.)
<p>
The length operator applied on a table
returns a border in that table.
A <em>border</em> in a table <code>t</code> is any natural number
that satisfies the following condition:
<pre>
(border == 0 or t[border] ~= nil) and t[border + 1] == nil
</pre><p>
In words,
a border is any (natural) index present in the table
that is followed by an absent index
(or zero, when index 1 is absent).
<p>
A table with exactly one border is called a <em>sequence</em>.
For instance, the table <code>{10, 20, 30, 40, 50}</code> is a sequence,
as it has only one border (5).
The table <code>{10, 20, 30, nil, 50}</code> has two borders (3 and 5),
and therefore it is not a sequence.
(The <b>nil</b> at index 4 is called a <em>hole</em>.)
The table <code>{nil, 20, 30, nil, nil, 60, nil}</code>
has three borders (0, 3, and 6) and three holes
(at indices 1, 4, and 5),
so it is not a sequence, too.
The table <code>{}</code> is a sequence with border 0.
Note that non-natural keys do not interfere
with whether a table is a sequence.
<p>
When <code>t</code> is a sequence,
<code>#t</code> returns its only border,
which corresponds to the intuitive notion of the length of the sequence.
When <code>t</code> is not a sequence,
<code>#t</code> can return any of its borders.
(The exact one depends on details of
the internal representation of the table,
which in turn can depend on how the table was populated and
the memory addresses of its non-numeric keys.)
<p>
The computation of the length of a table
has a guaranteed worst time of <em>O(log n)</em>,
where <em>n</em> is the largest natural key in the table.
<p>
A program can modify the behavior of the length operator for
any value but strings through the <code>__len</code> metamethod (see <a href="#2.4">§2.4</a>).
<h3>3.4.8 – <a name="3.4.8">Precedence</a></h3><p>
Operator precedence in Lua follows the table below,
from lower to higher priority:
<pre>
or
and
< > <= >= ~= ==
|
~
&
<< >>
..
+ -
* / // %
unary operators (not # - ~)
^
</pre><p>
As usual,
you can use parentheses to change the precedences of an expression.
The concatenation ('<code>..</code>') and exponentiation ('<code>^</code>')
operators are right associative.
All other binary operators are left associative.
<h3>3.4.9 – <a name="3.4.9">Table Constructors</a></h3><p>
Table constructors are expressions that create tables.
Every time a constructor is evaluated, a new table is created.
A constructor can be used to create an empty table
or to create a table and initialize some of its fields.
The general syntax for constructors is
<pre>
tableconstructor ::= ‘<b>{</b>’ [fieldlist] ‘<b>}</b>’
fieldlist ::= field {fieldsep field} [fieldsep]
field ::= ‘<b>[</b>’ exp ‘<b>]</b>’ ‘<b>=</b>’ exp | Name ‘<b>=</b>’ exp | exp
fieldsep ::= ‘<b>,</b>’ | ‘<b>;</b>’
</pre>
<p>
Each field of the form <code>[exp1] = exp2</code> adds to the new table an entry
with key <code>exp1</code> and value <code>exp2</code>.
A field of the form <code>name = exp</code> is equivalent to
<code>["name"] = exp</code>.
Fields of the form <code>exp</code> are equivalent to
<code>[i] = exp</code>, where <code>i</code> are consecutive integers
starting with 1;
fields in the other formats do not affect this counting.
For example,
<pre>
a = { [f(1)] = g; "x", "y"; x = 1, f(x), [30] = 23; 45 }
</pre><p>
is equivalent to
<pre>
do
local t = {}
t[f(1)] = g
t[1] = "x" -- 1st exp
t[2] = "y" -- 2nd exp
t.x = 1 -- t["x"] = 1
t[3] = f(x) -- 3rd exp
t[30] = 23
t[4] = 45 -- 4th exp
a = t
end
</pre>
<p>
The order of the assignments in a constructor is undefined.
(This order would be relevant only when there are repeated keys.)
<p>
If the last field in the list has the form <code>exp</code>
and the expression is a function call or a vararg expression,
then all values returned by this expression enter the list consecutively
(see <a href="#3.4.10">§3.4.10</a>).
<p>
The field list can have an optional trailing separator,
as a convenience for machine-generated code.
<h3>3.4.10 – <a name="3.4.10">Function Calls</a></h3><p>
A function call in Lua has the following syntax:
<pre>
functioncall ::= prefixexp args
</pre><p>
In a function call,
first prefixexp and args are evaluated.
If the value of prefixexp has type <em>function</em>,
then this function is called
with the given arguments.
Otherwise, if present,
the prefixexp <code>__call</code> metamethod is called:
its first argument is the value of prefixexp,
followed by the original call arguments
(see <a href="#2.4">§2.4</a>).
<p>
The form
<pre>
functioncall ::= prefixexp ‘<b>:</b>’ Name args
</pre><p>
can be used to emulate methods.
A call <code>v:name(<em>args</em>)</code>
is syntactic sugar for <code>v.name(v,<em>args</em>)</code>,
except that <code>v</code> is evaluated only once.
<p>
Arguments have the following syntax:
<pre>
args ::= ‘<b>(</b>’ [explist] ‘<b>)</b>’
args ::= tableconstructor
args ::= LiteralString
</pre><p>
All argument expressions are evaluated before the call.
A call of the form <code>f{<em>fields</em>}</code> is
syntactic sugar for <code>f({<em>fields</em>})</code>;
that is, the argument list is a single new table.
A call of the form <code>f'<em>string</em>'</code>
(or <code>f"<em>string</em>"</code> or <code>f[[<em>string</em>]]</code>)
is syntactic sugar for <code>f('<em>string</em>')</code>;
that is, the argument list is a single literal string.
<p>
A call of the form <code>return <em>functioncall</em></code> not in the
scope of a to-be-closed variable is called a <em>tail call</em>.
Lua implements <em>proper tail calls</em>
(or <em>proper tail recursion</em>):
in a tail call,
the called function reuses the stack entry of the calling function.
Therefore, there is no limit on the number of nested tail calls that
a program can execute.
However, a tail call erases any debug information about the
calling function.
Note that a tail call only happens with a particular syntax,
where the <b>return</b> has one single function call as argument,
and it is outside the scope of any to-be-closed variable.
This syntax makes the calling function return exactly
the returns of the called function,
without any intervening action.
So, none of the following examples are tail calls:
<pre>
return (f(x)) -- results adjusted to 1
return 2 * f(x) -- result multiplied by 2
return x, f(x) -- additional results
f(x); return -- results discarded
return x or f(x) -- results adjusted to 1
</pre>
<h3>3.4.11 – <a name="3.4.11">Function Definitions</a></h3>
<p>
The syntax for function definition is
<pre>
functiondef ::= <b>function</b> funcbody
funcbody ::= ‘<b>(</b>’ [parlist] ‘<b>)</b>’ block <b>end</b>
</pre>
<p>
The following syntactic sugar simplifies function definitions:
<pre>
stat ::= <b>function</b> funcname funcbody
stat ::= <b>local</b> <b>function</b> Name funcbody
funcname ::= Name {‘<b>.</b>’ Name} [‘<b>:</b>’ Name]
</pre><p>
The statement
<pre>
function f () <em>body</em> end
</pre><p>
translates to
<pre>
f = function () <em>body</em> end
</pre><p>
The statement
<pre>
function t.a.b.c.f () <em>body</em> end
</pre><p>
translates to
<pre>
t.a.b.c.f = function () <em>body</em> end
</pre><p>
The statement
<pre>
local function f () <em>body</em> end
</pre><p>
translates to
<pre>
local f; f = function () <em>body</em> end
</pre><p>
not to
<pre>
local f = function () <em>body</em> end
</pre><p>
(This only makes a difference when the body of the function
contains references to <code>f</code>.)
<p>
A function definition is an executable expression,
whose value has type <em>function</em>.
When Lua precompiles a chunk,
all its function bodies are precompiled too,
but they are not created yet.
Then, whenever Lua executes the function definition,
the function is <em>instantiated</em> (or <em>closed</em>).
This function instance, or <em>closure</em>,
is the final value of the expression.
<p>
Parameters act as local variables that are
initialized with the argument values:
<pre>
parlist ::= namelist [‘<b>,</b>’ ‘<b>...</b>’] | ‘<b>...</b>’
</pre><p>
When a Lua function is called,
it adjusts its list of arguments to
the length of its list of parameters,
unless the function is a <em>vararg function</em>,
which is indicated by three dots ('<code>...</code>')
at the end of its parameter list.
A vararg function does not adjust its argument list;
instead, it collects all extra arguments and supplies them
to the function through a <em>vararg expression</em>,
which is also written as three dots.
The value of this expression is a list of all actual extra arguments,
similar to a function with multiple results.
If a vararg expression is used inside another expression
or in the middle of a list of expressions,
then its return list is adjusted to one element.
If the expression is used as the last element of a list of expressions,
then no adjustment is made
(unless that last expression is enclosed in parentheses).
<p>
As an example, consider the following definitions:
<pre>
function f(a, b) end
function g(a, b, ...) end
function r() return 1,2,3 end
</pre><p>
Then, we have the following mapping from arguments to parameters and
to the vararg expression:
<pre>
CALL PARAMETERS
f(3) a=3, b=nil
f(3, 4) a=3, b=4
f(3, 4, 5) a=3, b=4
f(r(), 10) a=1, b=10
f(r()) a=1, b=2
g(3) a=3, b=nil, ... --> (nothing)
g(3, 4) a=3, b=4, ... --> (nothing)
g(3, 4, 5, 8) a=3, b=4, ... --> 5 8
g(5, r()) a=5, b=1, ... --> 2 3
</pre>
<p>
Results are returned using the <b>return</b> statement (see <a href="#3.3.4">§3.3.4</a>).
If control reaches the end of a function
without encountering a <b>return</b> statement,
then the function returns with no results.
<p>
There is a system-dependent limit on the number of values
that a function may return.
This limit is guaranteed to be greater than 1000.
<p>
The <em>colon</em> syntax
is used to emulate <em>methods</em>,
adding an implicit extra parameter <code>self</code> to the function.
Thus, the statement
<pre>
function t.a.b.c:f (<em>params</em>) <em>body</em> end
</pre><p>
is syntactic sugar for
<pre>
t.a.b.c.f = function (self, <em>params</em>) <em>body</em> end
</pre>
<h2>3.5 – <a name="3.5">Visibility Rules</a></h2>
<p>
Lua is a lexically scoped language.
The scope of a local variable begins at the first statement after
its declaration and lasts until the last non-void statement
of the innermost block that includes the declaration.
Consider the following example:
<pre>
x = 10 -- global variable
do -- new block
local x = x -- new 'x', with value 10
print(x) --> 10
x = x+1
do -- another block
local x = x+1 -- another 'x'
print(x) --> 12
end
print(x) --> 11
end
print(x) --> 10 (the global one)
</pre>
<p>
Notice that, in a declaration like <code>local x = x</code>,
the new <code>x</code> being declared is not in scope yet,
and so the second <code>x</code> refers to the outside variable.
<p>
Because of the lexical scoping rules,
local variables can be freely accessed by functions
defined inside their scope.
A local variable used by an inner function is called an <em>upvalue</em>
(or <em>external local variable</em>, or simply <em>external variable</em>)
inside the inner function.
<p>
Notice that each execution of a <b>local</b> statement
defines new local variables.
Consider the following example:
<pre>
a = {}
local x = 20
for i = 1, 10 do
local y = 0
a[i] = function () y = y + 1; return x + y end
end
</pre><p>
The loop creates ten closures
(that is, ten instances of the anonymous function).
Each of these closures uses a different <code>y</code> variable,
while all of them share the same <code>x</code>.
<h1>4 – <a name="4">The Application Program Interface</a></h1>
<p>
This section describes the C API for Lua, that is,
the set of C functions available to the host program to communicate
with Lua.
All API functions and related types and constants
are declared in the header file <a name="pdf-lua.h"><code>lua.h</code></a>.
<p>
Even when we use the term "function",
any facility in the API may be provided as a macro instead.
Except where stated otherwise,
all such macros use each of their arguments exactly once
(except for the first argument, which is always a Lua state),
and so do not generate any hidden side-effects.
<p>
As in most C libraries,
the Lua API functions do not check their arguments
for validity or consistency.
However, you can change this behavior by compiling Lua
with the macro <a name="pdf-LUA_USE_APICHECK"><code>LUA_USE_APICHECK</code></a> defined.
<p>
The Lua library is fully reentrant:
it has no global variables.
It keeps all information it needs in a dynamic structure,
called the <em>Lua state</em>.
<p>
Each Lua state has one or more threads,
which correspond to independent, cooperative lines of execution.
The type <a href="#lua_State"><code>lua_State</code></a> (despite its name) refers to a thread.
(Indirectly, through the thread, it also refers to the
Lua state associated to the thread.)
<p>
A pointer to a thread must be passed as the first argument to
every function in the library, except to <a href="#lua_newstate"><code>lua_newstate</code></a>,
which creates a Lua state from scratch and returns a pointer
to the <em>main thread</em> in the new state.
<h2>4.1 – <a name="4.1">The Stack</a></h2>
<p>
Lua uses a <em>virtual stack</em> to pass values to and from C.
Each element in this stack represents a Lua value
(<b>nil</b>, number, string, etc.).
Functions in the API can access this stack through the
Lua state parameter that they receive.
<p>
Whenever Lua calls C, the called function gets a new stack,
which is independent of previous stacks and of stacks of
C functions that are still active.
This stack initially contains any arguments to the C function
and it is where the C function can store temporary
Lua values and must push its results
to be returned to the caller (see <a href="#lua_CFunction"><code>lua_CFunction</code></a>).
<p>
For convenience,
most query operations in the API do not follow a strict stack discipline.
Instead, they can refer to any element in the stack
by using an <em>index</em>:
A positive index represents an absolute stack position,
starting at 1 as the bottom of the stack;
a negative index represents an offset relative to the top of the stack.
More specifically, if the stack has <em>n</em> elements,
then index 1 represents the first element
(that is, the element that was pushed onto the stack first)
and
index <em>n</em> represents the last element;
index -1 also represents the last element
(that is, the element at the top)
and index <em>-n</em> represents the first element.
<h3>4.1.1 – <a name="4.1.1">Stack Size</a></h3>
<p>
When you interact with the Lua API,
you are responsible for ensuring consistency.
In particular,
<em>you are responsible for controlling stack overflow</em>.
When you call any API function,
you must ensure the stack has enough room to accommodate the results.
<p>
There is one exception to the above rule:
When you call a Lua function
without a fixed number of results (see <a href="#lua_call"><code>lua_call</code></a>),
Lua ensures that the stack has enough space for all results.
However, it does not ensure any extra space.
So, before pushing anything on the stack after such a call
you should use <a href="#lua_checkstack"><code>lua_checkstack</code></a>.
<p>
Whenever Lua calls C,
it ensures that the stack has space for
at least <a name="pdf-LUA_MINSTACK"><code>LUA_MINSTACK</code></a> extra elements;
that is, you can safely push up to <code>LUA_MINSTACK</code> values into it.
<code>LUA_MINSTACK</code> is defined as 20,
so that usually you do not have to worry about stack space
unless your code has loops pushing elements onto the stack.
Whenever necessary,
you can use the function <a href="#lua_checkstack"><code>lua_checkstack</code></a>
to ensure that the stack has enough space for pushing new elements.
<h3>4.1.2 – <a name="4.1.2">Valid and Acceptable Indices</a></h3>
<p>
Any function in the API that receives stack indices
works only with <em>valid indices</em> or <em>acceptable indices</em>.
<p>
A <em>valid index</em> is an index that refers to a
position that stores a modifiable Lua value.
It comprises stack indices between 1 and the stack top
(<code>1 ≤ abs(index) ≤ top</code>)
plus <em>pseudo-indices</em>,
which represent some positions that are accessible to C code
but that are not in the stack.
Pseudo-indices are used to access the registry (see <a href="#4.3">§4.3</a>)
and the upvalues of a C function (see <a href="#4.2">§4.2</a>).
<p>
Functions that do not need a specific mutable position,
but only a value (e.g., query functions),
can be called with acceptable indices.
An <em>acceptable index</em> can be any valid index,
but it also can be any positive index after the stack top
within the space allocated for the stack,
that is, indices up to the stack size.
(Note that 0 is never an acceptable index.)
Indices to upvalues (see <a href="#4.2">§4.2</a>) greater than the real number
of upvalues in the current C function are also acceptable (but invalid).
Except when noted otherwise,
functions in the API work with acceptable indices.
<p>
Acceptable indices serve to avoid extra tests
against the stack top when querying the stack.
For instance, a C function can query its third argument
without the need to check whether there is a third argument,
that is, without the need to check whether 3 is a valid index.
<p>
For functions that can be called with acceptable indices,
any non-valid index is treated as if it
contains a value of a virtual type <a name="pdf-LUA_TNONE"><code>LUA_TNONE</code></a>,
which behaves like a nil value.
<h3>4.1.3 – <a name="4.1.3">Pointers to strings</a></h3>
<p>
Several functions in the API return pointers (<code>const char*</code>)
to Lua strings in the stack.
(See <a href="#lua_pushfstring"><code>lua_pushfstring</code></a>, <a href="#lua_pushlstring"><code>lua_pushlstring</code></a>,
<a href="#lua_pushstring"><code>lua_pushstring</code></a>, and <a href="#lua_tolstring"><code>lua_tolstring</code></a>.
See also <a href="#luaL_checklstring"><code>luaL_checklstring</code></a>, <a href="#luaL_checkstring"><code>luaL_checkstring</code></a>,
and <a href="#luaL_tolstring"><code>luaL_tolstring</code></a> in the auxiliary library.)
<p>
In general,
Lua's garbage collection can free or move internal memory
and then invalidate pointers to internal strings.
To allow a safe use of these pointers,
The API guarantees that any pointer to a string in a stack index
is valid while the string value at that index is not removed from the stack.
(It can be moved to another index, though.)
When the index is a pseudo-index (referring to an upvalue),
the pointer is valid while the corresponding call is active and
the corresponding upvalue is not modified.
<p>
Some functions in the debug interface
also return pointers to strings,
namely <a href="#lua_getlocal"><code>lua_getlocal</code></a>, <a href="#lua_getupvalue"><code>lua_getupvalue</code></a>,
<a href="#lua_setlocal"><code>lua_setlocal</code></a>, and <a href="#lua_setupvalue"><code>lua_setupvalue</code></a>.
For these functions, the pointer is guaranteed to
be valid while the caller function is active and
the given closure (if one was given) is in the stack.
<p>
Except for these guarantees,
the garbage collector is free to invalidate
any pointer to internal strings.
<h2>4.2 – <a name="4.2">C Closures</a></h2>
<p>
When a C function is created,
it is possible to associate some values with it,
thus creating a <em>C closure</em>
(see <a href="#lua_pushcclosure"><code>lua_pushcclosure</code></a>);
these values are called <em>upvalues</em> and are
accessible to the function whenever it is called.
<p>
Whenever a C function is called,
its upvalues are located at specific pseudo-indices.
These pseudo-indices are produced by the macro
<a href="#lua_upvalueindex"><code>lua_upvalueindex</code></a>.
The first upvalue associated with a function is at index
<code>lua_upvalueindex(1)</code>, and so on.
Any access to <code>lua_upvalueindex(<em>n</em>)</code>,
where <em>n</em> is greater than the number of upvalues of the
current function
(but not greater than 256,
which is one plus the maximum number of upvalues in a closure),
produces an acceptable but invalid index.
<p>
A C closure can also change the values
of its corresponding upvalues.
<h2>4.3 – <a name="4.3">Registry</a></h2>
<p>
Lua provides a <em>registry</em>,
a predefined table that can be used by any C code to
store whatever Lua values it needs to store.
The registry table is always accessible at pseudo-index
<a name="pdf-LUA_REGISTRYINDEX"><code>LUA_REGISTRYINDEX</code></a>.
Any C library can store data into this table,
but it must take care to choose keys
that are different from those used
by other libraries, to avoid collisions.
Typically, you should use as key a string containing your library name,
or a light userdata with the address of a C object in your code,
or any Lua object created by your code.
As with variable names,
string keys starting with an underscore followed by
uppercase letters are reserved for Lua.
<p>
The integer keys in the registry are used
by the reference mechanism (see <a href="#luaL_ref"><code>luaL_ref</code></a>)
and by some predefined values.
Therefore, integer keys in the registry
must not be used for other purposes.
<p>
When you create a new Lua state,
its registry comes with some predefined values.
These predefined values are indexed with integer keys
defined as constants in <code>lua.h</code>.
The following constants are defined:
<ul>
<li><b><a name="pdf-LUA_RIDX_MAINTHREAD"><code>LUA_RIDX_MAINTHREAD</code></a>: </b> At this index the registry has
the main thread of the state.
(The main thread is the one created together with the state.)
</li>
<li><b><a name="pdf-LUA_RIDX_GLOBALS"><code>LUA_RIDX_GLOBALS</code></a>: </b> At this index the registry has
the global environment.
</li>
</ul>
<h2>4.4 – <a name="4.4">Error Handling in C</a></h2>
<p>
Internally, Lua uses the C <code>longjmp</code> facility to handle errors.
(Lua will use exceptions if you compile it as C++;
search for <code>LUAI_THROW</code> in the source code for details.)
When Lua faces any error,
such as a memory allocation error or a type error,
it <em>raises</em> an error;
that is, it does a long jump.
A <em>protected environment</em> uses <code>setjmp</code>
to set a recovery point;
any error jumps to the most recent active recovery point.
<p>
Inside a C function you can raise an error explicitly
by calling <a href="#lua_error"><code>lua_error</code></a>.
<p>
Most functions in the API can raise an error,
for instance due to a memory allocation error.
The documentation for each function indicates whether
it can raise errors.
<p>
If an error happens outside any protected environment,
Lua calls a <em>panic function</em> (see <a href="#lua_atpanic"><code>lua_atpanic</code></a>)
and then calls <code>abort</code>,
thus exiting the host application.
Your panic function can avoid this exit by
never returning
(e.g., doing a long jump to your own recovery point outside Lua).
<p>
The panic function,
as its name implies,
is a mechanism of last resort.
Programs should avoid it.
As a general rule,
when a C function is called by Lua with a Lua state,
it can do whatever it wants on that Lua state,
as it should be already protected.
However,
when C code operates on other Lua states
(e.g., a Lua-state argument to the function,
a Lua state stored in the registry, or
the result of <a href="#lua_newthread"><code>lua_newthread</code></a>),
it should use them only in API calls that cannot raise errors.
<p>
The panic function runs as if it were a message handler (see <a href="#2.3">§2.3</a>);
in particular, the error object is on the top of the stack.
However, there is no guarantee about stack space.
To push anything on the stack,
the panic function must first check the available space (see <a href="#4.1.1">§4.1.1</a>).
<h3>4.4.1 – <a name="4.4.1">Status Codes</a></h3>
<p>
Several functions that report errors in the API use the following
status codes to indicate different kinds of errors or other conditions:
<ul>
<li><b><a name="pdf-LUA_OK"><code>LUA_OK</code></a> (0): </b> no errors.</li>
<li><b><a name="pdf-LUA_ERRRUN"><code>LUA_ERRRUN</code></a>: </b> a runtime error.</li>
<li><b><a name="pdf-LUA_ERRMEM"><code>LUA_ERRMEM</code></a>: </b>
memory allocation error.
For such errors, Lua does not call the message handler.
</li>
<li><b><a name="pdf-LUA_ERRERR"><code>LUA_ERRERR</code></a>: </b> error while running the message handler.</li>
<li><b><a name="pdf-LUA_ERRSYNTAX"><code>LUA_ERRSYNTAX</code></a>: </b> syntax error during precompilation.</li>
<li><b><a name="pdf-LUA_YIELD"><code>LUA_YIELD</code></a>: </b> the thread (coroutine) yields.</li>
<li><b><a name="pdf-LUA_ERRFILE"><code>LUA_ERRFILE</code></a>: </b> a file-related error;
e.g., it cannot open or read the file.</li>
</ul><p>
These constants are defined in the header file <code>lua.h</code>.
<h2>4.5 – <a name="4.5">Handling Yields in C</a></h2>
<p>
Internally, Lua uses the C <code>longjmp</code> facility to yield a coroutine.
Therefore, if a C function <code>foo</code> calls an API function
and this API function yields
(directly or indirectly by calling another function that yields),
Lua cannot return to <code>foo</code> any more,
because the <code>longjmp</code> removes its frame from the C stack.
<p>
To avoid this kind of problem,
Lua raises an error whenever it tries to yield across an API call,
except for three functions:
<a href="#lua_yieldk"><code>lua_yieldk</code></a>, <a href="#lua_callk"><code>lua_callk</code></a>, and <a href="#lua_pcallk"><code>lua_pcallk</code></a>.
All those functions receive a <em>continuation function</em>
(as a parameter named <code>k</code>) to continue execution after a yield.
<p>
We need to set some terminology to explain continuations.
We have a C function called from Lua which we will call
the <em>original function</em>.
This original function then calls one of those three functions in the C API,
which we will call the <em>callee function</em>,
that then yields the current thread.
This can happen when the callee function is <a href="#lua_yieldk"><code>lua_yieldk</code></a>,
or when the callee function is either <a href="#lua_callk"><code>lua_callk</code></a> or <a href="#lua_pcallk"><code>lua_pcallk</code></a>
and the function called by them yields.
<p>
Suppose the running thread yields while executing the callee function.
After the thread resumes,
it eventually will finish running the callee function.
However,
the callee function cannot return to the original function,
because its frame in the C stack was destroyed by the yield.
Instead, Lua calls a <em>continuation function</em>,
which was given as an argument to the callee function.
As the name implies,
the continuation function should continue the task
of the original function.
<p>
As an illustration, consider the following function:
<pre>
int original_function (lua_State *L) {
... /* code 1 */
status = lua_pcall(L, n, m, h); /* calls Lua */
... /* code 2 */
}
</pre><p>
Now we want to allow
the Lua code being run by <a href="#lua_pcall"><code>lua_pcall</code></a> to yield.
First, we can rewrite our function like here:
<pre>
int k (lua_State *L, int status, lua_KContext ctx) {
... /* code 2 */
}
int original_function (lua_State *L) {
... /* code 1 */
return k(L, lua_pcall(L, n, m, h), ctx);
}
</pre><p>
In the above code,
the new function <code>k</code> is a
<em>continuation function</em> (with type <a href="#lua_KFunction"><code>lua_KFunction</code></a>),
which should do all the work that the original function
was doing after calling <a href="#lua_pcall"><code>lua_pcall</code></a>.
Now, we must inform Lua that it must call <code>k</code> if the Lua code
being executed by <a href="#lua_pcall"><code>lua_pcall</code></a> gets interrupted in some way
(errors or yielding),
so we rewrite the code as here,
replacing <a href="#lua_pcall"><code>lua_pcall</code></a> by <a href="#lua_pcallk"><code>lua_pcallk</code></a>:
<pre>
int original_function (lua_State *L) {
... /* code 1 */
return k(L, lua_pcallk(L, n, m, h, ctx2, k), ctx1);
}
</pre><p>
Note the external, explicit call to the continuation:
Lua will call the continuation only if needed, that is,
in case of errors or resuming after a yield.
If the called function returns normally without ever yielding,
<a href="#lua_pcallk"><code>lua_pcallk</code></a> (and <a href="#lua_callk"><code>lua_callk</code></a>) will also return normally.
(Of course, instead of calling the continuation in that case,
you can do the equivalent work directly inside the original function.)
<p>
Besides the Lua state,
the continuation function has two other parameters:
the final status of the call and the context value (<code>ctx</code>) that
was passed originally to <a href="#lua_pcallk"><code>lua_pcallk</code></a>.
Lua does not use this context value;
it only passes this value from the original function to the
continuation function.
For <a href="#lua_pcallk"><code>lua_pcallk</code></a>,
the status is the same value that would be returned by <a href="#lua_pcallk"><code>lua_pcallk</code></a>,
except that it is <a href="#pdf-LUA_YIELD"><code>LUA_YIELD</code></a> when being executed after a yield
(instead of <a href="#pdf-LUA_OK"><code>LUA_OK</code></a>).
For <a href="#lua_yieldk"><code>lua_yieldk</code></a> and <a href="#lua_callk"><code>lua_callk</code></a>,
the status is always <a href="#pdf-LUA_YIELD"><code>LUA_YIELD</code></a> when Lua calls the continuation.
(For these two functions,
Lua will not call the continuation in case of errors,
because they do not handle errors.)
Similarly, when using <a href="#lua_callk"><code>lua_callk</code></a>,
you should call the continuation function
with <a href="#pdf-LUA_OK"><code>LUA_OK</code></a> as the status.
(For <a href="#lua_yieldk"><code>lua_yieldk</code></a>, there is not much point in calling
directly the continuation function,
because <a href="#lua_yieldk"><code>lua_yieldk</code></a> usually does not return.)
<p>
Lua treats the continuation function as if it were the original function.
The continuation function receives the same Lua stack
from the original function,
in the same state it would be if the callee function had returned.
(For instance,
after a <a href="#lua_callk"><code>lua_callk</code></a> the function and its arguments are
removed from the stack and replaced by the results from the call.)
It also has the same upvalues.
Whatever it returns is handled by Lua as if it were the return
of the original function.
<h2>4.6 – <a name="4.6">Functions and Types</a></h2>
<p>
Here we list all functions and types from the C API in
alphabetical order.
Each function has an indicator like this:
<span class="apii">[-o, +p, <em>x</em>]</span>
<p>
The first field, <code>o</code>,
is how many elements the function pops from the stack.
The second field, <code>p</code>,
is how many elements the function pushes onto the stack.
(Any function always pushes its results after popping its arguments.)
A field in the form <code>x|y</code> means the function can push (or pop)
<code>x</code> or <code>y</code> elements,
depending on the situation;
an interrogation mark '<code>?</code>' means that
we cannot know how many elements the function pops/pushes
by looking only at its arguments.
(For instance, they may depend on what is in the stack.)
The third field, <code>x</code>,
tells whether the function may raise errors:
'<code>-</code>' means the function never raises any error;
'<code>m</code>' means the function may raise only out-of-memory errors;
'<code>v</code>' means the function may raise the errors explained in the text;
'<code>e</code>' means the function can run arbitrary Lua code,
either directly or through metamethods,
and therefore may raise any errors.
<hr><h3><a name="lua_absindex"><code>lua_absindex</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_absindex (lua_State *L, int idx);</pre>
<p>
Converts the acceptable index <code>idx</code>
into an equivalent absolute index
(that is, one that does not depend on the stack size).
<hr><h3><a name="lua_Alloc"><code>lua_Alloc</code></a></h3>
<pre>typedef void * (*lua_Alloc) (void *ud,
void *ptr,
size_t osize,
size_t nsize);</pre>
<p>
The type of the memory-allocation function used by Lua states.
The allocator function must provide a
functionality similar to <code>realloc</code>,
but not exactly the same.
Its arguments are
<code>ud</code>, an opaque pointer passed to <a href="#lua_newstate"><code>lua_newstate</code></a>;
<code>ptr</code>, a pointer to the block being allocated/reallocated/freed;
<code>osize</code>, the original size of the block or some code about what
is being allocated;
and <code>nsize</code>, the new size of the block.
<p>
When <code>ptr</code> is not <code>NULL</code>,
<code>osize</code> is the size of the block pointed by <code>ptr</code>,
that is, the size given when it was allocated or reallocated.
<p>
When <code>ptr</code> is <code>NULL</code>,
<code>osize</code> encodes the kind of object that Lua is allocating.
<code>osize</code> is any of
<a href="#pdf-LUA_TSTRING"><code>LUA_TSTRING</code></a>, <a href="#pdf-LUA_TTABLE"><code>LUA_TTABLE</code></a>, <a href="#pdf-LUA_TFUNCTION"><code>LUA_TFUNCTION</code></a>,
<a href="#pdf-LUA_TUSERDATA"><code>LUA_TUSERDATA</code></a>, or <a href="#pdf-LUA_TTHREAD"><code>LUA_TTHREAD</code></a> when (and only when)
Lua is creating a new object of that type.
When <code>osize</code> is some other value,
Lua is allocating memory for something else.
<p>
Lua assumes the following behavior from the allocator function:
<p>
When <code>nsize</code> is zero,
the allocator must behave like <code>free</code>
and then return <code>NULL</code>.
<p>
When <code>nsize</code> is not zero,
the allocator must behave like <code>realloc</code>.
In particular, the allocator returns <code>NULL</code>
if and only if it cannot fulfill the request.
<p>
Here is a simple implementation for the allocator function.
It is used in the auxiliary library by <a href="#luaL_newstate"><code>luaL_newstate</code></a>.
<pre>
static void *l_alloc (void *ud, void *ptr, size_t osize,
size_t nsize) {
(void)ud; (void)osize; /* not used */
if (nsize == 0) {
free(ptr);
return NULL;
}
else
return realloc(ptr, nsize);
}
</pre><p>
Note that Standard C ensures
that <code>free(NULL)</code> has no effect and that
<code>realloc(NULL,size)</code> is equivalent to <code>malloc(size)</code>.
<hr><h3><a name="lua_arith"><code>lua_arith</code></a></h3><p>
<span class="apii">[-(2|1), +1, <em>e</em>]</span>
<pre>void lua_arith (lua_State *L, int op);</pre>
<p>
Performs an arithmetic or bitwise operation over the two values
(or one, in the case of negations)
at the top of the stack,
with the value on the top being the second operand,
pops these values, and pushes the result of the operation.
The function follows the semantics of the corresponding Lua operator
(that is, it may call metamethods).
<p>
The value of <code>op</code> must be one of the following constants:
<ul>
<li><b><a name="pdf-LUA_OPADD"><code>LUA_OPADD</code></a>: </b> performs addition (<code>+</code>)</li>
<li><b><a name="pdf-LUA_OPSUB"><code>LUA_OPSUB</code></a>: </b> performs subtraction (<code>-</code>)</li>
<li><b><a name="pdf-LUA_OPMUL"><code>LUA_OPMUL</code></a>: </b> performs multiplication (<code>*</code>)</li>
<li><b><a name="pdf-LUA_OPDIV"><code>LUA_OPDIV</code></a>: </b> performs float division (<code>/</code>)</li>
<li><b><a name="pdf-LUA_OPIDIV"><code>LUA_OPIDIV</code></a>: </b> performs floor division (<code>//</code>)</li>
<li><b><a name="pdf-LUA_OPMOD"><code>LUA_OPMOD</code></a>: </b> performs modulo (<code>%</code>)</li>
<li><b><a name="pdf-LUA_OPPOW"><code>LUA_OPPOW</code></a>: </b> performs exponentiation (<code>^</code>)</li>
<li><b><a name="pdf-LUA_OPUNM"><code>LUA_OPUNM</code></a>: </b> performs mathematical negation (unary <code>-</code>)</li>
<li><b><a name="pdf-LUA_OPBNOT"><code>LUA_OPBNOT</code></a>: </b> performs bitwise NOT (<code>~</code>)</li>
<li><b><a name="pdf-LUA_OPBAND"><code>LUA_OPBAND</code></a>: </b> performs bitwise AND (<code>&</code>)</li>
<li><b><a name="pdf-LUA_OPBOR"><code>LUA_OPBOR</code></a>: </b> performs bitwise OR (<code>|</code>)</li>
<li><b><a name="pdf-LUA_OPBXOR"><code>LUA_OPBXOR</code></a>: </b> performs bitwise exclusive OR (<code>~</code>)</li>
<li><b><a name="pdf-LUA_OPSHL"><code>LUA_OPSHL</code></a>: </b> performs left shift (<code><<</code>)</li>
<li><b><a name="pdf-LUA_OPSHR"><code>LUA_OPSHR</code></a>: </b> performs right shift (<code>>></code>)</li>
</ul>
<hr><h3><a name="lua_atpanic"><code>lua_atpanic</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>lua_CFunction lua_atpanic (lua_State *L, lua_CFunction panicf);</pre>
<p>
Sets a new panic function and returns the old one (see <a href="#4.4">§4.4</a>).
<hr><h3><a name="lua_call"><code>lua_call</code></a></h3><p>
<span class="apii">[-(nargs+1), +nresults, <em>e</em>]</span>
<pre>void lua_call (lua_State *L, int nargs, int nresults);</pre>
<p>
Calls a function.
Like regular Lua calls,
<code>lua_call</code> respects the <code>__call</code> metamethod.
So, here the word "function"
means any callable value.
<p>
To do a call you must use the following protocol:
first, the function to be called is pushed onto the stack;
then, the arguments to the call are pushed
in direct order;
that is, the first argument is pushed first.
Finally you call <a href="#lua_call"><code>lua_call</code></a>;
<code>nargs</code> is the number of arguments that you pushed onto the stack.
When the function returns,
all arguments and the function value are popped
and the call results are pushed onto the stack.
The number of results is adjusted to <code>nresults</code>,
unless <code>nresults</code> is <a name="pdf-LUA_MULTRET"><code>LUA_MULTRET</code></a>.
In this case, all results from the function are pushed;
Lua takes care that the returned values fit into the stack space,
but it does not ensure any extra space in the stack.
The function results are pushed onto the stack in direct order
(the first result is pushed first),
so that after the call the last result is on the top of the stack.
<p>
Any error while calling and running the function is propagated upwards
(with a <code>longjmp</code>).
<p>
The following example shows how the host program can do the
equivalent to this Lua code:
<pre>
a = f("how", t.x, 14)
</pre><p>
Here it is in C:
<pre>
lua_getglobal(L, "f"); /* function to be called */
lua_pushliteral(L, "how"); /* 1st argument */
lua_getglobal(L, "t"); /* table to be indexed */
lua_getfield(L, -1, "x"); /* push result of t.x (2nd arg) */
lua_remove(L, -2); /* remove 't' from the stack */
lua_pushinteger(L, 14); /* 3rd argument */
lua_call(L, 3, 1); /* call 'f' with 3 arguments and 1 result */
lua_setglobal(L, "a"); /* set global 'a' */
</pre><p>
Note that the code above is <em>balanced</em>:
at its end, the stack is back to its original configuration.
This is considered good programming practice.
<hr><h3><a name="lua_callk"><code>lua_callk</code></a></h3><p>
<span class="apii">[-(nargs + 1), +nresults, <em>e</em>]</span>
<pre>void lua_callk (lua_State *L,
int nargs,
int nresults,
lua_KContext ctx,
lua_KFunction k);</pre>
<p>
This function behaves exactly like <a href="#lua_call"><code>lua_call</code></a>,
but allows the called function to yield (see <a href="#4.5">§4.5</a>).
<hr><h3><a name="lua_CFunction"><code>lua_CFunction</code></a></h3>
<pre>typedef int (*lua_CFunction) (lua_State *L);</pre>
<p>
Type for C functions.
<p>
In order to communicate properly with Lua,
a C function must use the following protocol,
which defines the way parameters and results are passed:
a C function receives its arguments from Lua in its stack
in direct order (the first argument is pushed first).
So, when the function starts,
<code>lua_gettop(L)</code> returns the number of arguments received by the function.
The first argument (if any) is at index 1
and its last argument is at index <code>lua_gettop(L)</code>.
To return values to Lua, a C function just pushes them onto the stack,
in direct order (the first result is pushed first),
and returns in C the number of results.
Any other value in the stack below the results will be properly
discarded by Lua.
Like a Lua function, a C function called by Lua can also return
many results.
<p>
As an example, the following function receives a variable number
of numeric arguments and returns their average and their sum:
<pre>
static int foo (lua_State *L) {
int n = lua_gettop(L); /* number of arguments */
lua_Number sum = 0.0;
int i;
for (i = 1; i <= n; i++) {
if (!lua_isnumber(L, i)) {
lua_pushliteral(L, "incorrect argument");
lua_error(L);
}
sum += lua_tonumber(L, i);
}
lua_pushnumber(L, sum/n); /* first result */
lua_pushnumber(L, sum); /* second result */
return 2; /* number of results */
}
</pre>
<hr><h3><a name="lua_checkstack"><code>lua_checkstack</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_checkstack (lua_State *L, int n);</pre>
<p>
Ensures that the stack has space for at least <code>n</code> extra elements,
that is, that you can safely push up to <code>n</code> values into it.
It returns false if it cannot fulfill the request,
either because it would cause the stack
to be greater than a fixed maximum size
(typically at least several thousand elements) or
because it cannot allocate memory for the extra space.
This function never shrinks the stack;
if the stack already has space for the extra elements,
it is left unchanged.
<hr><h3><a name="lua_close"><code>lua_close</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>void lua_close (lua_State *L);</pre>
<p>
Close all active to-be-closed variables in the main thread,
release all objects in the given Lua state
(calling the corresponding garbage-collection metamethods, if any),
and frees all dynamic memory used by this state.
<p>
On several platforms, you may not need to call this function,
because all resources are naturally released when the host program ends.
On the other hand, long-running programs that create multiple states,
such as daemons or web servers,
will probably need to close states as soon as they are not needed.
<hr><h3><a name="lua_closeslot"><code>lua_closeslot</code></a></h3><p>
<span class="apii">[-0, +0, <em>e</em>]</span>
<pre>void lua_closeslot (lua_State *L, int index);</pre>
<p>
Close the to-be-closed slot at the given index and set its value to <b>nil</b>.
The index must be the last index previously marked to be closed
(see <a href="#lua_toclose"><code>lua_toclose</code></a>) that is still active (that is, not closed yet).
<p>
A <code>__close</code> metamethod cannot yield
when called through this function.
<p>
(Exceptionally, this function was introduced in release 5.4.3.
It is not present in previous 5.4 releases.)
<hr><h3><a name="lua_compare"><code>lua_compare</code></a></h3><p>
<span class="apii">[-0, +0, <em>e</em>]</span>
<pre>int lua_compare (lua_State *L, int index1, int index2, int op);</pre>
<p>
Compares two Lua values.
Returns 1 if the value at index <code>index1</code> satisfies <code>op</code>
when compared with the value at index <code>index2</code>,
following the semantics of the corresponding Lua operator
(that is, it may call metamethods).
Otherwise returns 0.
Also returns 0 if any of the indices is not valid.
<p>
The value of <code>op</code> must be one of the following constants:
<ul>
<li><b><a name="pdf-LUA_OPEQ"><code>LUA_OPEQ</code></a>: </b> compares for equality (<code>==</code>)</li>
<li><b><a name="pdf-LUA_OPLT"><code>LUA_OPLT</code></a>: </b> compares for less than (<code><</code>)</li>
<li><b><a name="pdf-LUA_OPLE"><code>LUA_OPLE</code></a>: </b> compares for less or equal (<code><=</code>)</li>
</ul>
<hr><h3><a name="lua_concat"><code>lua_concat</code></a></h3><p>
<span class="apii">[-n, +1, <em>e</em>]</span>
<pre>void lua_concat (lua_State *L, int n);</pre>
<p>
Concatenates the <code>n</code> values at the top of the stack,
pops them, and leaves the result on the top.
If <code>n</code> is 1, the result is the single value on the stack
(that is, the function does nothing);
if <code>n</code> is 0, the result is the empty string.
Concatenation is performed following the usual semantics of Lua
(see <a href="#3.4.6">§3.4.6</a>).
<hr><h3><a name="lua_copy"><code>lua_copy</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>void lua_copy (lua_State *L, int fromidx, int toidx);</pre>
<p>
Copies the element at index <code>fromidx</code>
into the valid index <code>toidx</code>,
replacing the value at that position.
Values at other positions are not affected.
<hr><h3><a name="lua_createtable"><code>lua_createtable</code></a></h3><p>
<span class="apii">[-0, +1, <em>m</em>]</span>
<pre>void lua_createtable (lua_State *L, int narr, int nrec);</pre>
<p>
Creates a new empty table and pushes it onto the stack.
Parameter <code>narr</code> is a hint for how many elements the table
will have as a sequence;
parameter <code>nrec</code> is a hint for how many other elements
the table will have.
Lua may use these hints to preallocate memory for the new table.
This preallocation may help performance when you know in advance
how many elements the table will have.
Otherwise you can use the function <a href="#lua_newtable"><code>lua_newtable</code></a>.
<hr><h3><a name="lua_dump"><code>lua_dump</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_dump (lua_State *L,
lua_Writer writer,
void *data,
int strip);</pre>
<p>
Dumps a function as a binary chunk.
Receives a Lua function on the top of the stack
and produces a binary chunk that,
if loaded again,
results in a function equivalent to the one dumped.
As it produces parts of the chunk,
<a href="#lua_dump"><code>lua_dump</code></a> calls function <code>writer</code> (see <a href="#lua_Writer"><code>lua_Writer</code></a>)
with the given <code>data</code>
to write them.
<p>
If <code>strip</code> is true,
the binary representation may not include all debug information
about the function,
to save space.
<p>
The value returned is the error code returned by the last
call to the writer;
0 means no errors.
<p>
This function does not pop the Lua function from the stack.
<hr><h3><a name="lua_error"><code>lua_error</code></a></h3><p>
<span class="apii">[-1, +0, <em>v</em>]</span>
<pre>int lua_error (lua_State *L);</pre>
<p>
Raises a Lua error,
using the value on the top of the stack as the error object.
This function does a long jump,
and therefore never returns
(see <a href="#luaL_error"><code>luaL_error</code></a>).
<hr><h3><a name="lua_gc"><code>lua_gc</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_gc (lua_State *L, int what, ...);</pre>
<p>
Controls the garbage collector.
<p>
This function performs several tasks,
according to the value of the parameter <code>what</code>.
For options that need extra arguments,
they are listed after the option.
<ul>
<li><b><code>LUA_GCCOLLECT</code>: </b>
Performs a full garbage-collection cycle.
</li>
<li><b><code>LUA_GCSTOP</code>: </b>
Stops the garbage collector.
</li>
<li><b><code>LUA_GCRESTART</code>: </b>
Restarts the garbage collector.
</li>
<li><b><code>LUA_GCCOUNT</code>: </b>
Returns the current amount of memory (in Kbytes) in use by Lua.
</li>
<li><b><code>LUA_GCCOUNTB</code>: </b>
Returns the remainder of dividing the current amount of bytes of
memory in use by Lua by 1024.
</li>
<li><b><code>LUA_GCSTEP</code> <code>(int stepsize)</code>: </b>
Performs an incremental step of garbage collection,
corresponding to the allocation of <code>stepsize</code> Kbytes.
</li>
<li><b><code>LUA_GCISRUNNING</code>: </b>
Returns a boolean that tells whether the collector is running
(i.e., not stopped).
</li>
<li><b><code>LUA_GCINC</code> (int pause, int stepmul, stepsize): </b>
Changes the collector to incremental mode
with the given parameters (see <a href="#2.5.1">§2.5.1</a>).
Returns the previous mode (<code>LUA_GCGEN</code> or <code>LUA_GCINC</code>).
</li>
<li><b><code>LUA_GCGEN</code> (int minormul, int majormul): </b>
Changes the collector to generational mode
with the given parameters (see <a href="#2.5.2">§2.5.2</a>).
Returns the previous mode (<code>LUA_GCGEN</code> or <code>LUA_GCINC</code>).
</li>
</ul><p>
For more details about these options,
see <a href="#pdf-collectgarbage"><code>collectgarbage</code></a>.
<hr><h3><a name="lua_getallocf"><code>lua_getallocf</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>lua_Alloc lua_getallocf (lua_State *L, void **ud);</pre>
<p>
Returns the memory-allocation function of a given state.
If <code>ud</code> is not <code>NULL</code>, Lua stores in <code>*ud</code> the
opaque pointer given when the memory-allocator function was set.
<hr><h3><a name="lua_getfield"><code>lua_getfield</code></a></h3><p>
<span class="apii">[-0, +1, <em>e</em>]</span>
<pre>int lua_getfield (lua_State *L, int index, const char *k);</pre>
<p>
Pushes onto the stack the value <code>t[k]</code>,
where <code>t</code> is the value at the given index.
As in Lua, this function may trigger a metamethod
for the "index" event (see <a href="#2.4">§2.4</a>).
<p>
Returns the type of the pushed value.
<hr><h3><a name="lua_getextraspace"><code>lua_getextraspace</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>void *lua_getextraspace (lua_State *L);</pre>
<p>
Returns a pointer to a raw memory area associated with the
given Lua state.
The application can use this area for any purpose;
Lua does not use it for anything.
<p>
Each new thread has this area initialized with a copy
of the area of the main thread.
<p>
By default, this area has the size of a pointer to void,
but you can recompile Lua with a different size for this area.
(See <code>LUA_EXTRASPACE</code> in <code>luaconf.h</code>.)
<hr><h3><a name="lua_getglobal"><code>lua_getglobal</code></a></h3><p>
<span class="apii">[-0, +1, <em>e</em>]</span>
<pre>int lua_getglobal (lua_State *L, const char *name);</pre>
<p>
Pushes onto the stack the value of the global <code>name</code>.
Returns the type of that value.
<hr><h3><a name="lua_geti"><code>lua_geti</code></a></h3><p>
<span class="apii">[-0, +1, <em>e</em>]</span>
<pre>int lua_geti (lua_State *L, int index, lua_Integer i);</pre>
<p>
Pushes onto the stack the value <code>t[i]</code>,
where <code>t</code> is the value at the given index.
As in Lua, this function may trigger a metamethod
for the "index" event (see <a href="#2.4">§2.4</a>).
<p>
Returns the type of the pushed value.
<hr><h3><a name="lua_getmetatable"><code>lua_getmetatable</code></a></h3><p>
<span class="apii">[-0, +(0|1), –]</span>
<pre>int lua_getmetatable (lua_State *L, int index);</pre>
<p>
If the value at the given index has a metatable,
the function pushes that metatable onto the stack and returns 1.
Otherwise,
the function returns 0 and pushes nothing on the stack.
<hr><h3><a name="lua_gettable"><code>lua_gettable</code></a></h3><p>
<span class="apii">[-1, +1, <em>e</em>]</span>
<pre>int lua_gettable (lua_State *L, int index);</pre>
<p>
Pushes onto the stack the value <code>t[k]</code>,
where <code>t</code> is the value at the given index
and <code>k</code> is the value on the top of the stack.
<p>
This function pops the key from the stack,
pushing the resulting value in its place.
As in Lua, this function may trigger a metamethod
for the "index" event (see <a href="#2.4">§2.4</a>).
<p>
Returns the type of the pushed value.
<hr><h3><a name="lua_gettop"><code>lua_gettop</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_gettop (lua_State *L);</pre>
<p>
Returns the index of the top element in the stack.
Because indices start at 1,
this result is equal to the number of elements in the stack;
in particular, 0 means an empty stack.
<hr><h3><a name="lua_getiuservalue"><code>lua_getiuservalue</code></a></h3><p>
<span class="apii">[-0, +1, –]</span>
<pre>int lua_getiuservalue (lua_State *L, int index, int n);</pre>
<p>
Pushes onto the stack the <code>n</code>-th user value associated with the
full userdata at the given index and
returns the type of the pushed value.
<p>
If the userdata does not have that value,
pushes <b>nil</b> and returns <a href="#pdf-LUA_TNONE"><code>LUA_TNONE</code></a>.
<hr><h3><a name="lua_insert"><code>lua_insert</code></a></h3><p>
<span class="apii">[-1, +1, –]</span>
<pre>void lua_insert (lua_State *L, int index);</pre>
<p>
Moves the top element into the given valid index,
shifting up the elements above this index to open space.
This function cannot be called with a pseudo-index,
because a pseudo-index is not an actual stack position.
<hr><h3><a name="lua_Integer"><code>lua_Integer</code></a></h3>
<pre>typedef ... lua_Integer;</pre>
<p>
The type of integers in Lua.
<p>
By default this type is <code>long long</code>,
(usually a 64-bit two-complement integer),
but that can be changed to <code>long</code> or <code>int</code>
(usually a 32-bit two-complement integer).
(See <code>LUA_INT_TYPE</code> in <code>luaconf.h</code>.)
<p>
Lua also defines the constants
<a name="pdf-LUA_MININTEGER"><code>LUA_MININTEGER</code></a> and <a name="pdf-LUA_MAXINTEGER"><code>LUA_MAXINTEGER</code></a>,
with the minimum and the maximum values that fit in this type.
<hr><h3><a name="lua_isboolean"><code>lua_isboolean</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_isboolean (lua_State *L, int index);</pre>
<p>
Returns 1 if the value at the given index is a boolean,
and 0 otherwise.
<hr><h3><a name="lua_iscfunction"><code>lua_iscfunction</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_iscfunction (lua_State *L, int index);</pre>
<p>
Returns 1 if the value at the given index is a C function,
and 0 otherwise.
<hr><h3><a name="lua_isfunction"><code>lua_isfunction</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_isfunction (lua_State *L, int index);</pre>
<p>
Returns 1 if the value at the given index is a function
(either C or Lua), and 0 otherwise.
<hr><h3><a name="lua_isinteger"><code>lua_isinteger</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_isinteger (lua_State *L, int index);</pre>
<p>
Returns 1 if the value at the given index is an integer
(that is, the value is a number and is represented as an integer),
and 0 otherwise.
<hr><h3><a name="lua_islightuserdata"><code>lua_islightuserdata</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_islightuserdata (lua_State *L, int index);</pre>
<p>
Returns 1 if the value at the given index is a light userdata,
and 0 otherwise.
<hr><h3><a name="lua_isnil"><code>lua_isnil</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_isnil (lua_State *L, int index);</pre>
<p>
Returns 1 if the value at the given index is <b>nil</b>,
and 0 otherwise.
<hr><h3><a name="lua_isnone"><code>lua_isnone</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_isnone (lua_State *L, int index);</pre>
<p>
Returns 1 if the given index is not valid,
and 0 otherwise.
<hr><h3><a name="lua_isnoneornil"><code>lua_isnoneornil</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_isnoneornil (lua_State *L, int index);</pre>
<p>
Returns 1 if the given index is not valid
or if the value at this index is <b>nil</b>,
and 0 otherwise.
<hr><h3><a name="lua_isnumber"><code>lua_isnumber</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_isnumber (lua_State *L, int index);</pre>
<p>
Returns 1 if the value at the given index is a number
or a string convertible to a number,
and 0 otherwise.
<hr><h3><a name="lua_isstring"><code>lua_isstring</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_isstring (lua_State *L, int index);</pre>
<p>
Returns 1 if the value at the given index is a string
or a number (which is always convertible to a string),
and 0 otherwise.
<hr><h3><a name="lua_istable"><code>lua_istable</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_istable (lua_State *L, int index);</pre>
<p>
Returns 1 if the value at the given index is a table,
and 0 otherwise.
<hr><h3><a name="lua_isthread"><code>lua_isthread</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_isthread (lua_State *L, int index);</pre>
<p>
Returns 1 if the value at the given index is a thread,
and 0 otherwise.
<hr><h3><a name="lua_isuserdata"><code>lua_isuserdata</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_isuserdata (lua_State *L, int index);</pre>
<p>
Returns 1 if the value at the given index is a userdata
(either full or light), and 0 otherwise.
<hr><h3><a name="lua_isyieldable"><code>lua_isyieldable</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_isyieldable (lua_State *L);</pre>
<p>
Returns 1 if the given coroutine can yield,
and 0 otherwise.
<hr><h3><a name="lua_KContext"><code>lua_KContext</code></a></h3>
<pre>typedef ... lua_KContext;</pre>
<p>
The type for continuation-function contexts.
It must be a numeric type.
This type is defined as <code>intptr_t</code>
when <code>intptr_t</code> is available,
so that it can store pointers too.
Otherwise, it is defined as <code>ptrdiff_t</code>.
<hr><h3><a name="lua_KFunction"><code>lua_KFunction</code></a></h3>
<pre>typedef int (*lua_KFunction) (lua_State *L, int status, lua_KContext ctx);</pre>
<p>
Type for continuation functions (see <a href="#4.5">§4.5</a>).
<hr><h3><a name="lua_len"><code>lua_len</code></a></h3><p>
<span class="apii">[-0, +1, <em>e</em>]</span>
<pre>void lua_len (lua_State *L, int index);</pre>
<p>
Returns the length of the value at the given index.
It is equivalent to the '<code>#</code>' operator in Lua (see <a href="#3.4.7">§3.4.7</a>) and
may trigger a metamethod for the "length" event (see <a href="#2.4">§2.4</a>).
The result is pushed on the stack.
<hr><h3><a name="lua_load"><code>lua_load</code></a></h3><p>
<span class="apii">[-0, +1, –]</span>
<pre>int lua_load (lua_State *L,
lua_Reader reader,
void *data,
const char *chunkname,
const char *mode);</pre>
<p>
Loads a Lua chunk without running it.
If there are no errors,
<code>lua_load</code> pushes the compiled chunk as a Lua
function on top of the stack.
Otherwise, it pushes an error message.
<p>
The <code>lua_load</code> function uses a user-supplied <code>reader</code> function
to read the chunk (see <a href="#lua_Reader"><code>lua_Reader</code></a>).
The <code>data</code> argument is an opaque value passed to the reader function.
<p>
The <code>chunkname</code> argument gives a name to the chunk,
which is used for error messages and in debug information (see <a href="#4.7">§4.7</a>).
<p>
<code>lua_load</code> automatically detects whether the chunk is text or binary
and loads it accordingly (see program <code>luac</code>).
The string <code>mode</code> works as in function <a href="#pdf-load"><code>load</code></a>,
with the addition that
a <code>NULL</code> value is equivalent to the string "<code>bt</code>".
<p>
<code>lua_load</code> uses the stack internally,
so the reader function must always leave the stack
unmodified when returning.
<p>
<code>lua_load</code> can return
<a href="#pdf-LUA_OK"><code>LUA_OK</code></a>, <a href="#pdf-LUA_ERRSYNTAX"><code>LUA_ERRSYNTAX</code></a>, or <a href="#pdf-LUA_ERRMEM"><code>LUA_ERRMEM</code></a>.
The function may also return other values corresponding to
errors raised by the read function (see <a href="#4.4.1">§4.4.1</a>).
<p>
If the resulting function has upvalues,
its first upvalue is set to the value of the global environment
stored at index <code>LUA_RIDX_GLOBALS</code> in the registry (see <a href="#4.3">§4.3</a>).
When loading main chunks,
this upvalue will be the <code>_ENV</code> variable (see <a href="#2.2">§2.2</a>).
Other upvalues are initialized with <b>nil</b>.
<hr><h3><a name="lua_newstate"><code>lua_newstate</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>lua_State *lua_newstate (lua_Alloc f, void *ud);</pre>
<p>
Creates a new independent state and returns its main thread.
Returns <code>NULL</code> if it cannot create the state
(due to lack of memory).
The argument <code>f</code> is the allocator function;
Lua will do all memory allocation for this state
through this function (see <a href="#lua_Alloc"><code>lua_Alloc</code></a>).
The second argument, <code>ud</code>, is an opaque pointer that Lua
passes to the allocator in every call.
<hr><h3><a name="lua_newtable"><code>lua_newtable</code></a></h3><p>
<span class="apii">[-0, +1, <em>m</em>]</span>
<pre>void lua_newtable (lua_State *L);</pre>
<p>
Creates a new empty table and pushes it onto the stack.
It is equivalent to <code>lua_createtable(L, 0, 0)</code>.
<hr><h3><a name="lua_newthread"><code>lua_newthread</code></a></h3><p>
<span class="apii">[-0, +1, <em>m</em>]</span>
<pre>lua_State *lua_newthread (lua_State *L);</pre>
<p>
Creates a new thread, pushes it on the stack,
and returns a pointer to a <a href="#lua_State"><code>lua_State</code></a> that represents this new thread.
The new thread returned by this function shares with the original thread
its global environment,
but has an independent execution stack.
<p>
Threads are subject to garbage collection,
like any Lua object.
<hr><h3><a name="lua_newuserdatauv"><code>lua_newuserdatauv</code></a></h3><p>
<span class="apii">[-0, +1, <em>m</em>]</span>
<pre>void *lua_newuserdatauv (lua_State *L, size_t size, int nuvalue);</pre>
<p>
This function creates and pushes on the stack a new full userdata,
with <code>nuvalue</code> associated Lua values, called <code>user values</code>,
plus an associated block of raw memory with <code>size</code> bytes.
(The user values can be set and read with the functions
<a href="#lua_setiuservalue"><code>lua_setiuservalue</code></a> and <a href="#lua_getiuservalue"><code>lua_getiuservalue</code></a>.)
<p>
The function returns the address of the block of memory.
Lua ensures that this address is valid as long as
the corresponding userdata is alive (see <a href="#2.5">§2.5</a>).
Moreover, if the userdata is marked for finalization (see <a href="#2.5.3">§2.5.3</a>),
its address is valid at least until the call to its finalizer.
<hr><h3><a name="lua_next"><code>lua_next</code></a></h3><p>
<span class="apii">[-1, +(2|0), <em>v</em>]</span>
<pre>int lua_next (lua_State *L, int index);</pre>
<p>
Pops a key from the stack,
and pushes a key–value pair from the table at the given index,
the "next" pair after the given key.
If there are no more elements in the table,
then <a href="#lua_next"><code>lua_next</code></a> returns 0 and pushes nothing.
<p>
A typical table traversal looks like this:
<pre>
/* table is in the stack at index 't' */
lua_pushnil(L); /* first key */
while (lua_next(L, t) != 0) {
/* uses 'key' (at index -2) and 'value' (at index -1) */
printf("%s - %s\n",
lua_typename(L, lua_type(L, -2)),
lua_typename(L, lua_type(L, -1)));
/* removes 'value'; keeps 'key' for next iteration */
lua_pop(L, 1);
}
</pre>
<p>
While traversing a table,
avoid calling <a href="#lua_tolstring"><code>lua_tolstring</code></a> directly on a key,
unless you know that the key is actually a string.
Recall that <a href="#lua_tolstring"><code>lua_tolstring</code></a> may change
the value at the given index;
this confuses the next call to <a href="#lua_next"><code>lua_next</code></a>.
<p>
This function may raise an error if the given key
is neither <b>nil</b> nor present in the table.
See function <a href="#pdf-next"><code>next</code></a> for the caveats of modifying
the table during its traversal.
<hr><h3><a name="lua_Number"><code>lua_Number</code></a></h3>
<pre>typedef ... lua_Number;</pre>
<p>
The type of floats in Lua.
<p>
By default this type is double,
but that can be changed to a single float or a long double.
(See <code>LUA_FLOAT_TYPE</code> in <code>luaconf.h</code>.)
<hr><h3><a name="lua_numbertointeger"><code>lua_numbertointeger</code></a></h3>
<pre>int lua_numbertointeger (lua_Number n, lua_Integer *p);</pre>
<p>
Tries to convert a Lua float to a Lua integer;
the float <code>n</code> must have an integral value.
If that value is within the range of Lua integers,
it is converted to an integer and assigned to <code>*p</code>.
The macro results in a boolean indicating whether the
conversion was successful.
(Note that this range test can be tricky to do
correctly without this macro, due to rounding.)
<p>
This macro may evaluate its arguments more than once.
<hr><h3><a name="lua_pcall"><code>lua_pcall</code></a></h3><p>
<span class="apii">[-(nargs + 1), +(nresults|1), –]</span>
<pre>int lua_pcall (lua_State *L, int nargs, int nresults, int msgh);</pre>
<p>
Calls a function (or a callable object) in protected mode.
<p>
Both <code>nargs</code> and <code>nresults</code> have the same meaning as
in <a href="#lua_call"><code>lua_call</code></a>.
If there are no errors during the call,
<a href="#lua_pcall"><code>lua_pcall</code></a> behaves exactly like <a href="#lua_call"><code>lua_call</code></a>.
However, if there is any error,
<a href="#lua_pcall"><code>lua_pcall</code></a> catches it,
pushes a single value on the stack (the error object),
and returns an error code.
Like <a href="#lua_call"><code>lua_call</code></a>,
<a href="#lua_pcall"><code>lua_pcall</code></a> always removes the function
and its arguments from the stack.
<p>
If <code>msgh</code> is 0,
then the error object returned on the stack
is exactly the original error object.
Otherwise, <code>msgh</code> is the stack index of a
<em>message handler</em>.
(This index cannot be a pseudo-index.)
In case of runtime errors,
this handler will be called with the error object
and its return value will be the object
returned on the stack by <a href="#lua_pcall"><code>lua_pcall</code></a>.
<p>
Typically, the message handler is used to add more debug
information to the error object, such as a stack traceback.
Such information cannot be gathered after the return of <a href="#lua_pcall"><code>lua_pcall</code></a>,
since by then the stack has unwound.
<p>
The <a href="#lua_pcall"><code>lua_pcall</code></a> function returns one of the following status codes:
<a href="#pdf-LUA_OK"><code>LUA_OK</code></a>, <a href="#pdf-LUA_ERRRUN"><code>LUA_ERRRUN</code></a>, <a href="#pdf-LUA_ERRMEM"><code>LUA_ERRMEM</code></a>, or <a href="#pdf-LUA_ERRERR"><code>LUA_ERRERR</code></a>.
<hr><h3><a name="lua_pcallk"><code>lua_pcallk</code></a></h3><p>
<span class="apii">[-(nargs + 1), +(nresults|1), –]</span>
<pre>int lua_pcallk (lua_State *L,
int nargs,
int nresults,
int msgh,
lua_KContext ctx,
lua_KFunction k);</pre>
<p>
This function behaves exactly like <a href="#lua_pcall"><code>lua_pcall</code></a>,
except that it allows the called function to yield (see <a href="#4.5">§4.5</a>).
<hr><h3><a name="lua_pop"><code>lua_pop</code></a></h3><p>
<span class="apii">[-n, +0, <em>e</em>]</span>
<pre>void lua_pop (lua_State *L, int n);</pre>
<p>
Pops <code>n</code> elements from the stack.
It is implemented as a macro over <a href="#lua_settop"><code>lua_settop</code></a>.
<hr><h3><a name="lua_pushboolean"><code>lua_pushboolean</code></a></h3><p>
<span class="apii">[-0, +1, –]</span>
<pre>void lua_pushboolean (lua_State *L, int b);</pre>
<p>
Pushes a boolean value with value <code>b</code> onto the stack.
<hr><h3><a name="lua_pushcclosure"><code>lua_pushcclosure</code></a></h3><p>
<span class="apii">[-n, +1, <em>m</em>]</span>
<pre>void lua_pushcclosure (lua_State *L, lua_CFunction fn, int n);</pre>
<p>
Pushes a new C closure onto the stack.
This function receives a pointer to a C function
and pushes onto the stack a Lua value of type <code>function</code> that,
when called, invokes the corresponding C function.
The parameter <code>n</code> tells how many upvalues this function will have
(see <a href="#4.2">§4.2</a>).
<p>
Any function to be callable by Lua must
follow the correct protocol to receive its parameters
and return its results (see <a href="#lua_CFunction"><code>lua_CFunction</code></a>).
<p>
When a C function is created,
it is possible to associate some values with it,
the so called upvalues;
these upvalues are then accessible to the function whenever it is called.
This association is called a C closure (see <a href="#4.2">§4.2</a>).
To create a C closure,
first the initial values for its upvalues must be pushed onto the stack.
(When there are multiple upvalues, the first value is pushed first.)
Then <a href="#lua_pushcclosure"><code>lua_pushcclosure</code></a>
is called to create and push the C function onto the stack,
with the argument <code>n</code> telling how many values will be
associated with the function.
<a href="#lua_pushcclosure"><code>lua_pushcclosure</code></a> also pops these values from the stack.
<p>
The maximum value for <code>n</code> is 255.
<p>
When <code>n</code> is zero,
this function creates a <em>light C function</em>,
which is just a pointer to the C function.
In that case, it never raises a memory error.
<hr><h3><a name="lua_pushcfunction"><code>lua_pushcfunction</code></a></h3><p>
<span class="apii">[-0, +1, –]</span>
<pre>void lua_pushcfunction (lua_State *L, lua_CFunction f);</pre>
<p>
Pushes a C function onto the stack.
This function is equivalent to <a href="#lua_pushcclosure"><code>lua_pushcclosure</code></a> with no upvalues.
<hr><h3><a name="lua_pushfstring"><code>lua_pushfstring</code></a></h3><p>
<span class="apii">[-0, +1, <em>v</em>]</span>
<pre>const char *lua_pushfstring (lua_State *L, const char *fmt, ...);</pre>
<p>
Pushes onto the stack a formatted string
and returns a pointer to this string (see <a href="#4.1.3">§4.1.3</a>).
It is similar to the ISO C function <code>sprintf</code>,
but has two important differences.
First,
you do not have to allocate space for the result;
the result is a Lua string and Lua takes care of memory allocation
(and deallocation, through garbage collection).
Second,
the conversion specifiers are quite restricted.
There are no flags, widths, or precisions.
The conversion specifiers can only be
'<code>%%</code>' (inserts the character '<code>%</code>'),
'<code>%s</code>' (inserts a zero-terminated string, with no size restrictions),
'<code>%f</code>' (inserts a <a href="#lua_Number"><code>lua_Number</code></a>),
'<code>%I</code>' (inserts a <a href="#lua_Integer"><code>lua_Integer</code></a>),
'<code>%p</code>' (inserts a pointer),
'<code>%d</code>' (inserts an <code>int</code>),
'<code>%c</code>' (inserts an <code>int</code> as a one-byte character), and
'<code>%U</code>' (inserts a <code>long int</code> as a UTF-8 byte sequence).
<p>
This function may raise errors due to memory overflow
or an invalid conversion specifier.
<hr><h3><a name="lua_pushglobaltable"><code>lua_pushglobaltable</code></a></h3><p>
<span class="apii">[-0, +1, –]</span>
<pre>void lua_pushglobaltable (lua_State *L);</pre>
<p>
Pushes the global environment onto the stack.
<hr><h3><a name="lua_pushinteger"><code>lua_pushinteger</code></a></h3><p>
<span class="apii">[-0, +1, –]</span>
<pre>void lua_pushinteger (lua_State *L, lua_Integer n);</pre>
<p>
Pushes an integer with value <code>n</code> onto the stack.
<hr><h3><a name="lua_pushlightuserdata"><code>lua_pushlightuserdata</code></a></h3><p>
<span class="apii">[-0, +1, –]</span>
<pre>void lua_pushlightuserdata (lua_State *L, void *p);</pre>
<p>
Pushes a light userdata onto the stack.
<p>
Userdata represent C values in Lua.
A <em>light userdata</em> represents a pointer, a <code>void*</code>.
It is a value (like a number):
you do not create it, it has no individual metatable,
and it is not collected (as it was never created).
A light userdata is equal to "any"
light userdata with the same C address.
<hr><h3><a name="lua_pushliteral"><code>lua_pushliteral</code></a></h3><p>
<span class="apii">[-0, +1, <em>m</em>]</span>
<pre>const char *lua_pushliteral (lua_State *L, const char *s);</pre>
<p>
This macro is equivalent to <a href="#lua_pushstring"><code>lua_pushstring</code></a>,
but should be used only when <code>s</code> is a literal string.
(Lua may optimize this case.)
<hr><h3><a name="lua_pushlstring"><code>lua_pushlstring</code></a></h3><p>
<span class="apii">[-0, +1, <em>m</em>]</span>
<pre>const char *lua_pushlstring (lua_State *L, const char *s, size_t len);</pre>
<p>
Pushes the string pointed to by <code>s</code> with size <code>len</code>
onto the stack.
Lua will make or reuse an internal copy of the given string,
so the memory at <code>s</code> can be freed or reused immediately after
the function returns.
The string can contain any binary data,
including embedded zeros.
<p>
Returns a pointer to the internal copy of the string (see <a href="#4.1.3">§4.1.3</a>).
<hr><h3><a name="lua_pushnil"><code>lua_pushnil</code></a></h3><p>
<span class="apii">[-0, +1, –]</span>
<pre>void lua_pushnil (lua_State *L);</pre>
<p>
Pushes a nil value onto the stack.
<hr><h3><a name="lua_pushnumber"><code>lua_pushnumber</code></a></h3><p>
<span class="apii">[-0, +1, –]</span>
<pre>void lua_pushnumber (lua_State *L, lua_Number n);</pre>
<p>
Pushes a float with value <code>n</code> onto the stack.
<hr><h3><a name="lua_pushstring"><code>lua_pushstring</code></a></h3><p>
<span class="apii">[-0, +1, <em>m</em>]</span>
<pre>const char *lua_pushstring (lua_State *L, const char *s);</pre>
<p>
Pushes the zero-terminated string pointed to by <code>s</code>
onto the stack.
Lua will make or reuse an internal copy of the given string,
so the memory at <code>s</code> can be freed or reused immediately after
the function returns.
<p>
Returns a pointer to the internal copy of the string (see <a href="#4.1.3">§4.1.3</a>).
<p>
If <code>s</code> is <code>NULL</code>, pushes <b>nil</b> and returns <code>NULL</code>.
<hr><h3><a name="lua_pushthread"><code>lua_pushthread</code></a></h3><p>
<span class="apii">[-0, +1, –]</span>
<pre>int lua_pushthread (lua_State *L);</pre>
<p>
Pushes the thread represented by <code>L</code> onto the stack.
Returns 1 if this thread is the main thread of its state.
<hr><h3><a name="lua_pushvalue"><code>lua_pushvalue</code></a></h3><p>
<span class="apii">[-0, +1, –]</span>
<pre>void lua_pushvalue (lua_State *L, int index);</pre>
<p>
Pushes a copy of the element at the given index
onto the stack.
<hr><h3><a name="lua_pushvfstring"><code>lua_pushvfstring</code></a></h3><p>
<span class="apii">[-0, +1, <em>v</em>]</span>
<pre>const char *lua_pushvfstring (lua_State *L,
const char *fmt,
va_list argp);</pre>
<p>
Equivalent to <a href="#lua_pushfstring"><code>lua_pushfstring</code></a>, except that it receives a <code>va_list</code>
instead of a variable number of arguments.
<hr><h3><a name="lua_rawequal"><code>lua_rawequal</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_rawequal (lua_State *L, int index1, int index2);</pre>
<p>
Returns 1 if the two values in indices <code>index1</code> and
<code>index2</code> are primitively equal
(that is, equal without calling the <code>__eq</code> metamethod).
Otherwise returns 0.
Also returns 0 if any of the indices are not valid.
<hr><h3><a name="lua_rawget"><code>lua_rawget</code></a></h3><p>
<span class="apii">[-1, +1, –]</span>
<pre>int lua_rawget (lua_State *L, int index);</pre>
<p>
Similar to <a href="#lua_gettable"><code>lua_gettable</code></a>, but does a raw access
(i.e., without metamethods).
<hr><h3><a name="lua_rawgeti"><code>lua_rawgeti</code></a></h3><p>
<span class="apii">[-0, +1, –]</span>
<pre>int lua_rawgeti (lua_State *L, int index, lua_Integer n);</pre>
<p>
Pushes onto the stack the value <code>t[n]</code>,
where <code>t</code> is the table at the given index.
The access is raw,
that is, it does not use the <code>__index</code> metavalue.
<p>
Returns the type of the pushed value.
<hr><h3><a name="lua_rawgetp"><code>lua_rawgetp</code></a></h3><p>
<span class="apii">[-0, +1, –]</span>
<pre>int lua_rawgetp (lua_State *L, int index, const void *p);</pre>
<p>
Pushes onto the stack the value <code>t[k]</code>,
where <code>t</code> is the table at the given index and
<code>k</code> is the pointer <code>p</code> represented as a light userdata.
The access is raw;
that is, it does not use the <code>__index</code> metavalue.
<p>
Returns the type of the pushed value.
<hr><h3><a name="lua_rawlen"><code>lua_rawlen</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>lua_Unsigned lua_rawlen (lua_State *L, int index);</pre>
<p>
Returns the raw "length" of the value at the given index:
for strings, this is the string length;
for tables, this is the result of the length operator ('<code>#</code>')
with no metamethods;
for userdata, this is the size of the block of memory allocated
for the userdata.
For other values, this call returns 0.
<hr><h3><a name="lua_rawset"><code>lua_rawset</code></a></h3><p>
<span class="apii">[-2, +0, <em>m</em>]</span>
<pre>void lua_rawset (lua_State *L, int index);</pre>
<p>
Similar to <a href="#lua_settable"><code>lua_settable</code></a>, but does a raw assignment
(i.e., without metamethods).
<hr><h3><a name="lua_rawseti"><code>lua_rawseti</code></a></h3><p>
<span class="apii">[-1, +0, <em>m</em>]</span>
<pre>void lua_rawseti (lua_State *L, int index, lua_Integer i);</pre>
<p>
Does the equivalent of <code>t[i] = v</code>,
where <code>t</code> is the table at the given index
and <code>v</code> is the value on the top of the stack.
<p>
This function pops the value from the stack.
The assignment is raw,
that is, it does not use the <code>__newindex</code> metavalue.
<hr><h3><a name="lua_rawsetp"><code>lua_rawsetp</code></a></h3><p>
<span class="apii">[-1, +0, <em>m</em>]</span>
<pre>void lua_rawsetp (lua_State *L, int index, const void *p);</pre>
<p>
Does the equivalent of <code>t[p] = v</code>,
where <code>t</code> is the table at the given index,
<code>p</code> is encoded as a light userdata,
and <code>v</code> is the value on the top of the stack.
<p>
This function pops the value from the stack.
The assignment is raw,
that is, it does not use the <code>__newindex</code> metavalue.
<hr><h3><a name="lua_Reader"><code>lua_Reader</code></a></h3>
<pre>typedef const char * (*lua_Reader) (lua_State *L,
void *data,
size_t *size);</pre>
<p>
The reader function used by <a href="#lua_load"><code>lua_load</code></a>.
Every time <a href="#lua_load"><code>lua_load</code></a> needs another piece of the chunk,
it calls the reader,
passing along its <code>data</code> parameter.
The reader must return a pointer to a block of memory
with a new piece of the chunk
and set <code>size</code> to the block size.
The block must exist until the reader function is called again.
To signal the end of the chunk,
the reader must return <code>NULL</code> or set <code>size</code> to zero.
The reader function may return pieces of any size greater than zero.
<hr><h3><a name="lua_register"><code>lua_register</code></a></h3><p>
<span class="apii">[-0, +0, <em>e</em>]</span>
<pre>void lua_register (lua_State *L, const char *name, lua_CFunction f);</pre>
<p>
Sets the C function <code>f</code> as the new value of global <code>name</code>.
It is defined as a macro:
<pre>
#define lua_register(L,n,f) \
(lua_pushcfunction(L, f), lua_setglobal(L, n))
</pre>
<hr><h3><a name="lua_remove"><code>lua_remove</code></a></h3><p>
<span class="apii">[-1, +0, –]</span>
<pre>void lua_remove (lua_State *L, int index);</pre>
<p>
Removes the element at the given valid index,
shifting down the elements above this index to fill the gap.
This function cannot be called with a pseudo-index,
because a pseudo-index is not an actual stack position.
<hr><h3><a name="lua_replace"><code>lua_replace</code></a></h3><p>
<span class="apii">[-1, +0, –]</span>
<pre>void lua_replace (lua_State *L, int index);</pre>
<p>
Moves the top element into the given valid index
without shifting any element
(therefore replacing the value at that given index),
and then pops the top element.
<hr><h3><a name="lua_resetthread"><code>lua_resetthread</code></a></h3><p>
<span class="apii">[-0, +?, –]</span>
<pre>int lua_resetthread (lua_State *L);</pre>
<p>
Resets a thread, cleaning its call stack and closing all pending
to-be-closed variables.
Returns a status code:
<a href="#pdf-LUA_OK"><code>LUA_OK</code></a> for no errors in the thread
(either the original error that stopped the thread or
errors in closing methods),
or an error status otherwise.
In case of error,
leaves the error object on the top of the stack.
<hr><h3><a name="lua_resume"><code>lua_resume</code></a></h3><p>
<span class="apii">[-?, +?, –]</span>
<pre>int lua_resume (lua_State *L, lua_State *from, int nargs,
int *nresults);</pre>
<p>
Starts and resumes a coroutine in the given thread <code>L</code>.
<p>
To start a coroutine,
you push the main function plus any arguments
onto the empty stack of the thread.
then you call <a href="#lua_resume"><code>lua_resume</code></a>,
with <code>nargs</code> being the number of arguments.
This call returns when the coroutine suspends or finishes its execution.
When it returns,
<code>*nresults</code> is updated and
the top of the stack contains
the <code>*nresults</code> values passed to <a href="#lua_yield"><code>lua_yield</code></a>
or returned by the body function.
<a href="#lua_resume"><code>lua_resume</code></a> returns
<a href="#pdf-LUA_YIELD"><code>LUA_YIELD</code></a> if the coroutine yields,
<a href="#pdf-LUA_OK"><code>LUA_OK</code></a> if the coroutine finishes its execution
without errors,
or an error code in case of errors (see <a href="#4.4.1">§4.4.1</a>).
In case of errors,
the error object is on the top of the stack.
<p>
To resume a coroutine,
you remove the <code>*nresults</code> yielded values from its stack,
push the values to be passed as results from <code>yield</code>,
and then call <a href="#lua_resume"><code>lua_resume</code></a>.
<p>
The parameter <code>from</code> represents the coroutine that is resuming <code>L</code>.
If there is no such coroutine,
this parameter can be <code>NULL</code>.
<hr><h3><a name="lua_rotate"><code>lua_rotate</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>void lua_rotate (lua_State *L, int idx, int n);</pre>
<p>
Rotates the stack elements between the valid index <code>idx</code>
and the top of the stack.
The elements are rotated <code>n</code> positions in the direction of the top,
for a positive <code>n</code>,
or <code>-n</code> positions in the direction of the bottom,
for a negative <code>n</code>.
The absolute value of <code>n</code> must not be greater than the size
of the slice being rotated.
This function cannot be called with a pseudo-index,
because a pseudo-index is not an actual stack position.
<hr><h3><a name="lua_setallocf"><code>lua_setallocf</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>void lua_setallocf (lua_State *L, lua_Alloc f, void *ud);</pre>
<p>
Changes the allocator function of a given state to <code>f</code>
with user data <code>ud</code>.
<hr><h3><a name="lua_setfield"><code>lua_setfield</code></a></h3><p>
<span class="apii">[-1, +0, <em>e</em>]</span>
<pre>void lua_setfield (lua_State *L, int index, const char *k);</pre>
<p>
Does the equivalent to <code>t[k] = v</code>,
where <code>t</code> is the value at the given index
and <code>v</code> is the value on the top of the stack.
<p>
This function pops the value from the stack.
As in Lua, this function may trigger a metamethod
for the "newindex" event (see <a href="#2.4">§2.4</a>).
<hr><h3><a name="lua_setglobal"><code>lua_setglobal</code></a></h3><p>
<span class="apii">[-1, +0, <em>e</em>]</span>
<pre>void lua_setglobal (lua_State *L, const char *name);</pre>
<p>
Pops a value from the stack and
sets it as the new value of global <code>name</code>.
<hr><h3><a name="lua_seti"><code>lua_seti</code></a></h3><p>
<span class="apii">[-1, +0, <em>e</em>]</span>
<pre>void lua_seti (lua_State *L, int index, lua_Integer n);</pre>
<p>
Does the equivalent to <code>t[n] = v</code>,
where <code>t</code> is the value at the given index
and <code>v</code> is the value on the top of the stack.
<p>
This function pops the value from the stack.
As in Lua, this function may trigger a metamethod
for the "newindex" event (see <a href="#2.4">§2.4</a>).
<hr><h3><a name="lua_setiuservalue"><code>lua_setiuservalue</code></a></h3><p>
<span class="apii">[-1, +0, –]</span>
<pre>int lua_setiuservalue (lua_State *L, int index, int n);</pre>
<p>
Pops a value from the stack and sets it as
the new <code>n</code>-th user value associated to the
full userdata at the given index.
Returns 0 if the userdata does not have that value.
<hr><h3><a name="lua_setmetatable"><code>lua_setmetatable</code></a></h3><p>
<span class="apii">[-1, +0, –]</span>
<pre>int lua_setmetatable (lua_State *L, int index);</pre>
<p>
Pops a table or <b>nil</b> from the stack and
sets that value as the new metatable for the value at the given index.
(<b>nil</b> means no metatable.)
<p>
(For historical reasons, this function returns an <code>int</code>,
which now is always 1.)
<hr><h3><a name="lua_settable"><code>lua_settable</code></a></h3><p>
<span class="apii">[-2, +0, <em>e</em>]</span>
<pre>void lua_settable (lua_State *L, int index);</pre>
<p>
Does the equivalent to <code>t[k] = v</code>,
where <code>t</code> is the value at the given index,
<code>v</code> is the value on the top of the stack,
and <code>k</code> is the value just below the top.
<p>
This function pops both the key and the value from the stack.
As in Lua, this function may trigger a metamethod
for the "newindex" event (see <a href="#2.4">§2.4</a>).
<hr><h3><a name="lua_settop"><code>lua_settop</code></a></h3><p>
<span class="apii">[-?, +?, <em>e</em>]</span>
<pre>void lua_settop (lua_State *L, int index);</pre>
<p>
Accepts any index, or 0,
and sets the stack top to this index.
If the new top is greater than the old one,
then the new elements are filled with <b>nil</b>.
If <code>index</code> is 0, then all stack elements are removed.
<p>
This function can run arbitrary code when removing an index
marked as to-be-closed from the stack.
<hr><h3><a name="lua_setwarnf"><code>lua_setwarnf</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>void lua_setwarnf (lua_State *L, lua_WarnFunction f, void *ud);</pre>
<p>
Sets the warning function to be used by Lua to emit warnings
(see <a href="#lua_WarnFunction"><code>lua_WarnFunction</code></a>).
The <code>ud</code> parameter sets the value <code>ud</code> passed to
the warning function.
<hr><h3><a name="lua_State"><code>lua_State</code></a></h3>
<pre>typedef struct lua_State lua_State;</pre>
<p>
An opaque structure that points to a thread and indirectly
(through the thread) to the whole state of a Lua interpreter.
The Lua library is fully reentrant:
it has no global variables.
All information about a state is accessible through this structure.
<p>
A pointer to this structure must be passed as the first argument to
every function in the library, except to <a href="#lua_newstate"><code>lua_newstate</code></a>,
which creates a Lua state from scratch.
<hr><h3><a name="lua_status"><code>lua_status</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_status (lua_State *L);</pre>
<p>
Returns the status of the thread <code>L</code>.
<p>
The status can be <a href="#pdf-LUA_OK"><code>LUA_OK</code></a> for a normal thread,
an error code if the thread finished the execution
of a <a href="#lua_resume"><code>lua_resume</code></a> with an error,
or <a href="#pdf-LUA_YIELD"><code>LUA_YIELD</code></a> if the thread is suspended.
<p>
You can call functions only in threads with status <a href="#pdf-LUA_OK"><code>LUA_OK</code></a>.
You can resume threads with status <a href="#pdf-LUA_OK"><code>LUA_OK</code></a>
(to start a new coroutine) or <a href="#pdf-LUA_YIELD"><code>LUA_YIELD</code></a>
(to resume a coroutine).
<hr><h3><a name="lua_stringtonumber"><code>lua_stringtonumber</code></a></h3><p>
<span class="apii">[-0, +1, –]</span>
<pre>size_t lua_stringtonumber (lua_State *L, const char *s);</pre>
<p>
Converts the zero-terminated string <code>s</code> to a number,
pushes that number into the stack,
and returns the total size of the string,
that is, its length plus one.
The conversion can result in an integer or a float,
according to the lexical conventions of Lua (see <a href="#3.1">§3.1</a>).
The string may have leading and trailing whitespaces and a sign.
If the string is not a valid numeral,
returns 0 and pushes nothing.
(Note that the result can be used as a boolean,
true if the conversion succeeds.)
<hr><h3><a name="lua_toboolean"><code>lua_toboolean</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_toboolean (lua_State *L, int index);</pre>
<p>
Converts the Lua value at the given index to a C boolean
value (0 or 1).
Like all tests in Lua,
<a href="#lua_toboolean"><code>lua_toboolean</code></a> returns true for any Lua value
different from <b>false</b> and <b>nil</b>;
otherwise it returns false.
(If you want to accept only actual boolean values,
use <a href="#lua_isboolean"><code>lua_isboolean</code></a> to test the value's type.)
<hr><h3><a name="lua_tocfunction"><code>lua_tocfunction</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>lua_CFunction lua_tocfunction (lua_State *L, int index);</pre>
<p>
Converts a value at the given index to a C function.
That value must be a C function;
otherwise, returns <code>NULL</code>.
<hr><h3><a name="lua_toclose"><code>lua_toclose</code></a></h3><p>
<span class="apii">[-0, +0, <em>m</em>]</span>
<pre>void lua_toclose (lua_State *L, int index);</pre>
<p>
Marks the given index in the stack as a
to-be-closed slot (see <a href="#3.3.8">§3.3.8</a>).
Like a to-be-closed variable in Lua,
the value at that slot in the stack will be closed
when it goes out of scope.
Here, in the context of a C function,
to go out of scope means that the running function returns to Lua,
or there is an error,
or the slot is removed from the stack through
<a href="#lua_settop"><code>lua_settop</code></a> or <a href="#lua_pop"><code>lua_pop</code></a>,
or there is a call to <a href="#lua_closeslot"><code>lua_closeslot</code></a>.
A slot marked as to-be-closed should not be removed from the stack
by any other function in the API except <a href="#lua_settop"><code>lua_settop</code></a> or <a href="#lua_pop"><code>lua_pop</code></a>,
unless previously deactivated by <a href="#lua_closeslot"><code>lua_closeslot</code></a>.
<p>
This function should not be called for an index
that is equal to or below an active to-be-closed slot.
<p>
Note that, both in case of errors and of a regular return,
by the time the <code>__close</code> metamethod runs,
the C stack was already unwound,
so that any automatic C variable declared in the calling function
(e.g., a buffer) will be out of scope.
<hr><h3><a name="lua_tointeger"><code>lua_tointeger</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>lua_Integer lua_tointeger (lua_State *L, int index);</pre>
<p>
Equivalent to <a href="#lua_tointegerx"><code>lua_tointegerx</code></a> with <code>isnum</code> equal to <code>NULL</code>.
<hr><h3><a name="lua_tointegerx"><code>lua_tointegerx</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>lua_Integer lua_tointegerx (lua_State *L, int index, int *isnum);</pre>
<p>
Converts the Lua value at the given index
to the signed integral type <a href="#lua_Integer"><code>lua_Integer</code></a>.
The Lua value must be an integer,
or a number or string convertible to an integer (see <a href="#3.4.3">§3.4.3</a>);
otherwise, <code>lua_tointegerx</code> returns 0.
<p>
If <code>isnum</code> is not <code>NULL</code>,
its referent is assigned a boolean value that
indicates whether the operation succeeded.
<hr><h3><a name="lua_tolstring"><code>lua_tolstring</code></a></h3><p>
<span class="apii">[-0, +0, <em>m</em>]</span>
<pre>const char *lua_tolstring (lua_State *L, int index, size_t *len);</pre>
<p>
Converts the Lua value at the given index to a C string.
If <code>len</code> is not <code>NULL</code>,
it sets <code>*len</code> with the string length.
The Lua value must be a string or a number;
otherwise, the function returns <code>NULL</code>.
If the value is a number,
then <code>lua_tolstring</code> also
<em>changes the actual value in the stack to a string</em>.
(This change confuses <a href="#lua_next"><code>lua_next</code></a>
when <code>lua_tolstring</code> is applied to keys during a table traversal.)
<p>
<code>lua_tolstring</code> returns a pointer
to a string inside the Lua state (see <a href="#4.1.3">§4.1.3</a>).
This string always has a zero ('<code>\0</code>')
after its last character (as in C),
but can contain other zeros in its body.
<hr><h3><a name="lua_tonumber"><code>lua_tonumber</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>lua_Number lua_tonumber (lua_State *L, int index);</pre>
<p>
Equivalent to <a href="#lua_tonumberx"><code>lua_tonumberx</code></a> with <code>isnum</code> equal to <code>NULL</code>.
<hr><h3><a name="lua_tonumberx"><code>lua_tonumberx</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>lua_Number lua_tonumberx (lua_State *L, int index, int *isnum);</pre>
<p>
Converts the Lua value at the given index
to the C type <a href="#lua_Number"><code>lua_Number</code></a> (see <a href="#lua_Number"><code>lua_Number</code></a>).
The Lua value must be a number or a string convertible to a number
(see <a href="#3.4.3">§3.4.3</a>);
otherwise, <a href="#lua_tonumberx"><code>lua_tonumberx</code></a> returns 0.
<p>
If <code>isnum</code> is not <code>NULL</code>,
its referent is assigned a boolean value that
indicates whether the operation succeeded.
<hr><h3><a name="lua_topointer"><code>lua_topointer</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>const void *lua_topointer (lua_State *L, int index);</pre>
<p>
Converts the value at the given index to a generic
C pointer (<code>void*</code>).
The value can be a userdata, a table, a thread, a string, or a function;
otherwise, <code>lua_topointer</code> returns <code>NULL</code>.
Different objects will give different pointers.
There is no way to convert the pointer back to its original value.
<p>
Typically this function is used only for hashing and debug information.
<hr><h3><a name="lua_tostring"><code>lua_tostring</code></a></h3><p>
<span class="apii">[-0, +0, <em>m</em>]</span>
<pre>const char *lua_tostring (lua_State *L, int index);</pre>
<p>
Equivalent to <a href="#lua_tolstring"><code>lua_tolstring</code></a> with <code>len</code> equal to <code>NULL</code>.
<hr><h3><a name="lua_tothread"><code>lua_tothread</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>lua_State *lua_tothread (lua_State *L, int index);</pre>
<p>
Converts the value at the given index to a Lua thread
(represented as <code>lua_State*</code>).
This value must be a thread;
otherwise, the function returns <code>NULL</code>.
<hr><h3><a name="lua_touserdata"><code>lua_touserdata</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>void *lua_touserdata (lua_State *L, int index);</pre>
<p>
If the value at the given index is a full userdata,
returns its memory-block address.
If the value is a light userdata,
returns its value (a pointer).
Otherwise, returns <code>NULL</code>.
<hr><h3><a name="lua_type"><code>lua_type</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_type (lua_State *L, int index);</pre>
<p>
Returns the type of the value in the given valid index,
or <code>LUA_TNONE</code> for a non-valid but acceptable index.
The types returned by <a href="#lua_type"><code>lua_type</code></a> are coded by the following constants
defined in <code>lua.h</code>:
<a name="pdf-LUA_TNIL"><code>LUA_TNIL</code></a>,
<a name="pdf-LUA_TNUMBER"><code>LUA_TNUMBER</code></a>,
<a name="pdf-LUA_TBOOLEAN"><code>LUA_TBOOLEAN</code></a>,
<a name="pdf-LUA_TSTRING"><code>LUA_TSTRING</code></a>,
<a name="pdf-LUA_TTABLE"><code>LUA_TTABLE</code></a>,
<a name="pdf-LUA_TFUNCTION"><code>LUA_TFUNCTION</code></a>,
<a name="pdf-LUA_TUSERDATA"><code>LUA_TUSERDATA</code></a>,
<a name="pdf-LUA_TTHREAD"><code>LUA_TTHREAD</code></a>,
and
<a name="pdf-LUA_TLIGHTUSERDATA"><code>LUA_TLIGHTUSERDATA</code></a>.
<hr><h3><a name="lua_typename"><code>lua_typename</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>const char *lua_typename (lua_State *L, int tp);</pre>
<p>
Returns the name of the type encoded by the value <code>tp</code>,
which must be one the values returned by <a href="#lua_type"><code>lua_type</code></a>.
<hr><h3><a name="lua_Unsigned"><code>lua_Unsigned</code></a></h3>
<pre>typedef ... lua_Unsigned;</pre>
<p>
The unsigned version of <a href="#lua_Integer"><code>lua_Integer</code></a>.
<hr><h3><a name="lua_upvalueindex"><code>lua_upvalueindex</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_upvalueindex (int i);</pre>
<p>
Returns the pseudo-index that represents the <code>i</code>-th upvalue of
the running function (see <a href="#4.2">§4.2</a>).
<code>i</code> must be in the range <em>[1,256]</em>.
<hr><h3><a name="lua_version"><code>lua_version</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>lua_Number lua_version (lua_State *L);</pre>
<p>
Returns the version number of this core.
<hr><h3><a name="lua_WarnFunction"><code>lua_WarnFunction</code></a></h3>
<pre>typedef void (*lua_WarnFunction) (void *ud, const char *msg, int tocont);</pre>
<p>
The type of warning functions, called by Lua to emit warnings.
The first parameter is an opaque pointer
set by <a href="#lua_setwarnf"><code>lua_setwarnf</code></a>.
The second parameter is the warning message.
The third parameter is a boolean that
indicates whether the message is
to be continued by the message in the next call.
<p>
See <a href="#pdf-warn"><code>warn</code></a> for more details about warnings.
<hr><h3><a name="lua_warning"><code>lua_warning</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>void lua_warning (lua_State *L, const char *msg, int tocont);</pre>
<p>
Emits a warning with the given message.
A message in a call with <code>tocont</code> true should be
continued in another call to this function.
<p>
See <a href="#pdf-warn"><code>warn</code></a> for more details about warnings.
<hr><h3><a name="lua_Writer"><code>lua_Writer</code></a></h3>
<pre>typedef int (*lua_Writer) (lua_State *L,
const void* p,
size_t sz,
void* ud);</pre>
<p>
The type of the writer function used by <a href="#lua_dump"><code>lua_dump</code></a>.
Every time <a href="#lua_dump"><code>lua_dump</code></a> produces another piece of chunk,
it calls the writer,
passing along the buffer to be written (<code>p</code>),
its size (<code>sz</code>),
and the <code>ud</code> parameter supplied to <a href="#lua_dump"><code>lua_dump</code></a>.
<p>
The writer returns an error code:
0 means no errors;
any other value means an error and stops <a href="#lua_dump"><code>lua_dump</code></a> from
calling the writer again.
<hr><h3><a name="lua_xmove"><code>lua_xmove</code></a></h3><p>
<span class="apii">[-?, +?, –]</span>
<pre>void lua_xmove (lua_State *from, lua_State *to, int n);</pre>
<p>
Exchange values between different threads of the same state.
<p>
This function pops <code>n</code> values from the stack <code>from</code>,
and pushes them onto the stack <code>to</code>.
<hr><h3><a name="lua_yield"><code>lua_yield</code></a></h3><p>
<span class="apii">[-?, +?, <em>v</em>]</span>
<pre>int lua_yield (lua_State *L, int nresults);</pre>
<p>
This function is equivalent to <a href="#lua_yieldk"><code>lua_yieldk</code></a>,
but it has no continuation (see <a href="#4.5">§4.5</a>).
Therefore, when the thread resumes,
it continues the function that called
the function calling <code>lua_yield</code>.
To avoid surprises,
this function should be called only in a tail call.
<hr><h3><a name="lua_yieldk"><code>lua_yieldk</code></a></h3><p>
<span class="apii">[-?, +?, <em>v</em>]</span>
<pre>int lua_yieldk (lua_State *L,
int nresults,
lua_KContext ctx,
lua_KFunction k);</pre>
<p>
Yields a coroutine (thread).
<p>
When a C function calls <a href="#lua_yieldk"><code>lua_yieldk</code></a>,
the running coroutine suspends its execution,
and the call to <a href="#lua_resume"><code>lua_resume</code></a> that started this coroutine returns.
The parameter <code>nresults</code> is the number of values from the stack
that will be passed as results to <a href="#lua_resume"><code>lua_resume</code></a>.
<p>
When the coroutine is resumed again,
Lua calls the given continuation function <code>k</code> to continue
the execution of the C function that yielded (see <a href="#4.5">§4.5</a>).
This continuation function receives the same stack
from the previous function,
with the <code>n</code> results removed and
replaced by the arguments passed to <a href="#lua_resume"><code>lua_resume</code></a>.
Moreover,
the continuation function receives the value <code>ctx</code>
that was passed to <a href="#lua_yieldk"><code>lua_yieldk</code></a>.
<p>
Usually, this function does not return;
when the coroutine eventually resumes,
it continues executing the continuation function.
However, there is one special case,
which is when this function is called
from inside a line or a count hook (see <a href="#4.7">§4.7</a>).
In that case, <code>lua_yieldk</code> should be called with no continuation
(probably in the form of <a href="#lua_yield"><code>lua_yield</code></a>) and no results,
and the hook should return immediately after the call.
Lua will yield and,
when the coroutine resumes again,
it will continue the normal execution
of the (Lua) function that triggered the hook.
<p>
This function can raise an error if it is called from a thread
with a pending C call with no continuation function
(what is called a <em>C-call boundary</em>),
or it is called from a thread that is not running inside a resume
(typically the main thread).
<h2>4.7 – <a name="4.7">The Debug Interface</a></h2>
<p>
Lua has no built-in debugging facilities.
Instead, it offers a special interface
by means of functions and <em>hooks</em>.
This interface allows the construction of different
kinds of debuggers, profilers, and other tools
that need "inside information" from the interpreter.
<hr><h3><a name="lua_Debug"><code>lua_Debug</code></a></h3>
<pre>typedef struct lua_Debug {
int event;
const char *name; /* (n) */
const char *namewhat; /* (n) */
const char *what; /* (S) */
const char *source; /* (S) */
size_t srclen; /* (S) */
int currentline; /* (l) */
int linedefined; /* (S) */
int lastlinedefined; /* (S) */
unsigned char nups; /* (u) number of upvalues */
unsigned char nparams; /* (u) number of parameters */
char isvararg; /* (u) */
char istailcall; /* (t) */
unsigned short ftransfer; /* (r) index of first value transferred */
unsigned short ntransfer; /* (r) number of transferred values */
char short_src[LUA_IDSIZE]; /* (S) */
/* private part */
<em>other fields</em>
} lua_Debug;</pre>
<p>
A structure used to carry different pieces of
information about a function or an activation record.
<a href="#lua_getstack"><code>lua_getstack</code></a> fills only the private part
of this structure, for later use.
To fill the other fields of <a href="#lua_Debug"><code>lua_Debug</code></a> with useful information,
you must call <a href="#lua_getinfo"><code>lua_getinfo</code></a>.
<p>
The fields of <a href="#lua_Debug"><code>lua_Debug</code></a> have the following meaning:
<ul>
<li><b><code>source</code>: </b>
the source of the chunk that created the function.
If <code>source</code> starts with a '<code>@</code>',
it means that the function was defined in a file where
the file name follows the '<code>@</code>'.
If <code>source</code> starts with a '<code>=</code>',
the remainder of its contents describes the source in a user-dependent manner.
Otherwise,
the function was defined in a string where
<code>source</code> is that string.
</li>
<li><b><code>srclen</code>: </b>
The length of the string <code>source</code>.
</li>
<li><b><code>short_src</code>: </b>
a "printable" version of <code>source</code>, to be used in error messages.
</li>
<li><b><code>linedefined</code>: </b>
the line number where the definition of the function starts.
</li>
<li><b><code>lastlinedefined</code>: </b>
the line number where the definition of the function ends.
</li>
<li><b><code>what</code>: </b>
the string <code>"Lua"</code> if the function is a Lua function,
<code>"C"</code> if it is a C function,
<code>"main"</code> if it is the main part of a chunk.
</li>
<li><b><code>currentline</code>: </b>
the current line where the given function is executing.
When no line information is available,
<code>currentline</code> is set to -1.
</li>
<li><b><code>name</code>: </b>
a reasonable name for the given function.
Because functions in Lua are first-class values,
they do not have a fixed name:
some functions can be the value of multiple global variables,
while others can be stored only in a table field.
The <code>lua_getinfo</code> function checks how the function was
called to find a suitable name.
If it cannot find a name,
then <code>name</code> is set to <code>NULL</code>.
</li>
<li><b><code>namewhat</code>: </b>
explains the <code>name</code> field.
The value of <code>namewhat</code> can be
<code>"global"</code>, <code>"local"</code>, <code>"method"</code>,
<code>"field"</code>, <code>"upvalue"</code>, or <code>""</code> (the empty string),
according to how the function was called.
(Lua uses the empty string when no other option seems to apply.)
</li>
<li><b><code>istailcall</code>: </b>
true if this function invocation was called by a tail call.
In this case, the caller of this level is not in the stack.
</li>
<li><b><code>nups</code>: </b>
the number of upvalues of the function.
</li>
<li><b><code>nparams</code>: </b>
the number of parameters of the function
(always 0 for C functions).
</li>
<li><b><code>isvararg</code>: </b>
true if the function is a vararg function
(always true for C functions).
</li>
<li><b><code>ftransfer</code>: </b>
the index in the stack of the first value being "transferred",
that is, parameters in a call or return values in a return.
(The other values are in consecutive indices.)
Using this index, you can access and modify these values
through <a href="#lua_getlocal"><code>lua_getlocal</code></a> and <a href="#lua_setlocal"><code>lua_setlocal</code></a>.
This field is only meaningful during a
call hook, denoting the first parameter,
or a return hook, denoting the first value being returned.
(For call hooks, this value is always 1.)
</li>
<li><b><code>ntransfer</code>: </b>
The number of values being transferred (see previous item).
(For calls of Lua functions,
this value is always equal to <code>nparams</code>.)
</li>
</ul>
<hr><h3><a name="lua_gethook"><code>lua_gethook</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>lua_Hook lua_gethook (lua_State *L);</pre>
<p>
Returns the current hook function.
<hr><h3><a name="lua_gethookcount"><code>lua_gethookcount</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_gethookcount (lua_State *L);</pre>
<p>
Returns the current hook count.
<hr><h3><a name="lua_gethookmask"><code>lua_gethookmask</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_gethookmask (lua_State *L);</pre>
<p>
Returns the current hook mask.
<hr><h3><a name="lua_getinfo"><code>lua_getinfo</code></a></h3><p>
<span class="apii">[-(0|1), +(0|1|2), <em>m</em>]</span>
<pre>int lua_getinfo (lua_State *L, const char *what, lua_Debug *ar);</pre>
<p>
Gets information about a specific function or function invocation.
<p>
To get information about a function invocation,
the parameter <code>ar</code> must be a valid activation record that was
filled by a previous call to <a href="#lua_getstack"><code>lua_getstack</code></a> or
given as argument to a hook (see <a href="#lua_Hook"><code>lua_Hook</code></a>).
<p>
To get information about a function, you push it onto the stack
and start the <code>what</code> string with the character '<code>></code>'.
(In that case,
<code>lua_getinfo</code> pops the function from the top of the stack.)
For instance, to know in which line a function <code>f</code> was defined,
you can write the following code:
<pre>
lua_Debug ar;
lua_getglobal(L, "f"); /* get global 'f' */
lua_getinfo(L, ">S", &ar);
printf("%d\n", ar.linedefined);
</pre>
<p>
Each character in the string <code>what</code>
selects some fields of the structure <code>ar</code> to be filled or
a value to be pushed on the stack:
<ul>
<li><b>'<code>n</code>': </b> fills in the field <code>name</code> and <code>namewhat</code>;
</li>
<li><b>'<code>S</code>': </b>
fills in the fields <code>source</code>, <code>short_src</code>,
<code>linedefined</code>, <code>lastlinedefined</code>, and <code>what</code>;
</li>
<li><b>'<code>l</code>': </b> fills in the field <code>currentline</code>;
</li>
<li><b>'<code>t</code>': </b> fills in the field <code>istailcall</code>;
</li>
<li><b>'<code>u</code>': </b> fills in the fields
<code>nups</code>, <code>nparams</code>, and <code>isvararg</code>;
</li>
<li><b>'<code>f</code>': </b>
pushes onto the stack the function that is
running at the given level;
</li>
<li><b>'<code>L</code>': </b>
pushes onto the stack a table whose indices are the
numbers of the lines that are valid on the function.
(A <em>valid line</em> is a line with some associated code,
that is, a line where you can put a break point.
Non-valid lines include empty lines and comments.)
<p>
If this option is given together with option '<code>f</code>',
its table is pushed after the function.
<p>
This is the only option that can raise a memory error.
</li>
</ul>
<p>
This function returns 0 to signal an invalid option in <code>what</code>;
even then the valid options are handled correctly.
<hr><h3><a name="lua_getlocal"><code>lua_getlocal</code></a></h3><p>
<span class="apii">[-0, +(0|1), –]</span>
<pre>const char *lua_getlocal (lua_State *L, const lua_Debug *ar, int n);</pre>
<p>
Gets information about a local variable or a temporary value
of a given activation record or a given function.
<p>
In the first case,
the parameter <code>ar</code> must be a valid activation record that was
filled by a previous call to <a href="#lua_getstack"><code>lua_getstack</code></a> or
given as argument to a hook (see <a href="#lua_Hook"><code>lua_Hook</code></a>).
The index <code>n</code> selects which local variable to inspect;
see <a href="#pdf-debug.getlocal"><code>debug.getlocal</code></a> for details about variable indices
and names.
<p>
<a href="#lua_getlocal"><code>lua_getlocal</code></a> pushes the variable's value onto the stack
and returns its name.
<p>
In the second case, <code>ar</code> must be <code>NULL</code> and the function
to be inspected must be on the top of the stack.
In this case, only parameters of Lua functions are visible
(as there is no information about what variables are active)
and no values are pushed onto the stack.
<p>
Returns <code>NULL</code> (and pushes nothing)
when the index is greater than
the number of active local variables.
<hr><h3><a name="lua_getstack"><code>lua_getstack</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>int lua_getstack (lua_State *L, int level, lua_Debug *ar);</pre>
<p>
Gets information about the interpreter runtime stack.
<p>
This function fills parts of a <a href="#lua_Debug"><code>lua_Debug</code></a> structure with
an identification of the <em>activation record</em>
of the function executing at a given level.
Level 0 is the current running function,
whereas level <em>n+1</em> is the function that has called level <em>n</em>
(except for tail calls, which do not count in the stack).
When called with a level greater than the stack depth,
<a href="#lua_getstack"><code>lua_getstack</code></a> returns 0;
otherwise it returns 1.
<hr><h3><a name="lua_getupvalue"><code>lua_getupvalue</code></a></h3><p>
<span class="apii">[-0, +(0|1), –]</span>
<pre>const char *lua_getupvalue (lua_State *L, int funcindex, int n);</pre>
<p>
Gets information about the <code>n</code>-th upvalue
of the closure at index <code>funcindex</code>.
It pushes the upvalue's value onto the stack
and returns its name.
Returns <code>NULL</code> (and pushes nothing)
when the index <code>n</code> is greater than the number of upvalues.
<p>
See <a href="#pdf-debug.getupvalue"><code>debug.getupvalue</code></a> for more information about upvalues.
<hr><h3><a name="lua_Hook"><code>lua_Hook</code></a></h3>
<pre>typedef void (*lua_Hook) (lua_State *L, lua_Debug *ar);</pre>
<p>
Type for debugging hook functions.
<p>
Whenever a hook is called, its <code>ar</code> argument has its field
<code>event</code> set to the specific event that triggered the hook.
Lua identifies these events with the following constants:
<a name="pdf-LUA_HOOKCALL"><code>LUA_HOOKCALL</code></a>, <a name="pdf-LUA_HOOKRET"><code>LUA_HOOKRET</code></a>,
<a name="pdf-LUA_HOOKTAILCALL"><code>LUA_HOOKTAILCALL</code></a>, <a name="pdf-LUA_HOOKLINE"><code>LUA_HOOKLINE</code></a>,
and <a name="pdf-LUA_HOOKCOUNT"><code>LUA_HOOKCOUNT</code></a>.
Moreover, for line events, the field <code>currentline</code> is also set.
To get the value of any other field in <code>ar</code>,
the hook must call <a href="#lua_getinfo"><code>lua_getinfo</code></a>.
<p>
For call events, <code>event</code> can be <code>LUA_HOOKCALL</code>,
the normal value, or <code>LUA_HOOKTAILCALL</code>, for a tail call;
in this case, there will be no corresponding return event.
<p>
While Lua is running a hook, it disables other calls to hooks.
Therefore, if a hook calls back Lua to execute a function or a chunk,
this execution occurs without any calls to hooks.
<p>
Hook functions cannot have continuations,
that is, they cannot call <a href="#lua_yieldk"><code>lua_yieldk</code></a>,
<a href="#lua_pcallk"><code>lua_pcallk</code></a>, or <a href="#lua_callk"><code>lua_callk</code></a> with a non-null <code>k</code>.
<p>
Hook functions can yield under the following conditions:
Only count and line events can yield;
to yield, a hook function must finish its execution
calling <a href="#lua_yield"><code>lua_yield</code></a> with <code>nresults</code> equal to zero
(that is, with no values).
<hr><h3><a name="lua_sethook"><code>lua_sethook</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>void lua_sethook (lua_State *L, lua_Hook f, int mask, int count);</pre>
<p>
Sets the debugging hook function.
<p>
Argument <code>f</code> is the hook function.
<code>mask</code> specifies on which events the hook will be called:
it is formed by a bitwise OR of the constants
<a name="pdf-LUA_MASKCALL"><code>LUA_MASKCALL</code></a>,
<a name="pdf-LUA_MASKRET"><code>LUA_MASKRET</code></a>,
<a name="pdf-LUA_MASKLINE"><code>LUA_MASKLINE</code></a>,
and <a name="pdf-LUA_MASKCOUNT"><code>LUA_MASKCOUNT</code></a>.
The <code>count</code> argument is only meaningful when the mask
includes <code>LUA_MASKCOUNT</code>.
For each event, the hook is called as explained below:
<ul>
<li><b>The call hook: </b> is called when the interpreter calls a function.
The hook is called just after Lua enters the new function.
</li>
<li><b>The return hook: </b> is called when the interpreter returns from a function.
The hook is called just before Lua leaves the function.
</li>
<li><b>The line hook: </b> is called when the interpreter is about to
start the execution of a new line of code,
or when it jumps back in the code (even to the same line).
This event only happens while Lua is executing a Lua function.
</li>
<li><b>The count hook: </b> is called after the interpreter executes every
<code>count</code> instructions.
This event only happens while Lua is executing a Lua function.
</li>
</ul>
<p>
Hooks are disabled by setting <code>mask</code> to zero.
<hr><h3><a name="lua_setlocal"><code>lua_setlocal</code></a></h3><p>
<span class="apii">[-(0|1), +0, –]</span>
<pre>const char *lua_setlocal (lua_State *L, const lua_Debug *ar, int n);</pre>
<p>
Sets the value of a local variable of a given activation record.
It assigns the value on the top of the stack
to the variable and returns its name.
It also pops the value from the stack.
<p>
Returns <code>NULL</code> (and pops nothing)
when the index is greater than
the number of active local variables.
<p>
Parameters <code>ar</code> and <code>n</code> are as in the function <a href="#lua_getlocal"><code>lua_getlocal</code></a>.
<hr><h3><a name="lua_setupvalue"><code>lua_setupvalue</code></a></h3><p>
<span class="apii">[-(0|1), +0, –]</span>
<pre>const char *lua_setupvalue (lua_State *L, int funcindex, int n);</pre>
<p>
Sets the value of a closure's upvalue.
It assigns the value on the top of the stack
to the upvalue and returns its name.
It also pops the value from the stack.
<p>
Returns <code>NULL</code> (and pops nothing)
when the index <code>n</code> is greater than the number of upvalues.
<p>
Parameters <code>funcindex</code> and <code>n</code> are as in
the function <a href="#lua_getupvalue"><code>lua_getupvalue</code></a>.
<hr><h3><a name="lua_upvalueid"><code>lua_upvalueid</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>void *lua_upvalueid (lua_State *L, int funcindex, int n);</pre>
<p>
Returns a unique identifier for the upvalue numbered <code>n</code>
from the closure at index <code>funcindex</code>.
<p>
These unique identifiers allow a program to check whether different
closures share upvalues.
Lua closures that share an upvalue
(that is, that access a same external local variable)
will return identical ids for those upvalue indices.
<p>
Parameters <code>funcindex</code> and <code>n</code> are as in
the function <a href="#lua_getupvalue"><code>lua_getupvalue</code></a>,
but <code>n</code> cannot be greater than the number of upvalues.
<hr><h3><a name="lua_upvaluejoin"><code>lua_upvaluejoin</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>void lua_upvaluejoin (lua_State *L, int funcindex1, int n1,
int funcindex2, int n2);</pre>
<p>
Make the <code>n1</code>-th upvalue of the Lua closure at index <code>funcindex1</code>
refer to the <code>n2</code>-th upvalue of the Lua closure at index <code>funcindex2</code>.
<h1>5 – <a name="5">The Auxiliary Library</a></h1>
<p>
The <em>auxiliary library</em> provides several convenient functions
to interface C with Lua.
While the basic API provides the primitive functions for all
interactions between C and Lua,
the auxiliary library provides higher-level functions for some
common tasks.
<p>
All functions and types from the auxiliary library
are defined in header file <code>lauxlib.h</code> and
have a prefix <code>luaL_</code>.
<p>
All functions in the auxiliary library are built on
top of the basic API,
and so they provide nothing that cannot be done with that API.
Nevertheless, the use of the auxiliary library ensures
more consistency to your code.
<p>
Several functions in the auxiliary library use internally some
extra stack slots.
When a function in the auxiliary library uses less than five slots,
it does not check the stack size;
it simply assumes that there are enough slots.
<p>
Several functions in the auxiliary library are used to
check C function arguments.
Because the error message is formatted for arguments
(e.g., "<code>bad argument #1</code>"),
you should not use these functions for other stack values.
<p>
Functions called <code>luaL_check*</code>
always raise an error if the check is not satisfied.
<h2>5.1 – <a name="5.1">Functions and Types</a></h2>
<p>
Here we list all functions and types from the auxiliary library
in alphabetical order.
<hr><h3><a name="luaL_addchar"><code>luaL_addchar</code></a></h3><p>
<span class="apii">[-?, +?, <em>m</em>]</span>
<pre>void luaL_addchar (luaL_Buffer *B, char c);</pre>
<p>
Adds the byte <code>c</code> to the buffer <code>B</code>
(see <a href="#luaL_Buffer"><code>luaL_Buffer</code></a>).
<hr><h3><a name="luaL_addgsub"><code>luaL_addgsub</code></a></h3><p>
<span class="apii">[-0, +0, <em>m</em>]</span>
<pre>const void luaL_addgsub (luaL_Buffer *B, const char *s,
const char *p, const char *r);</pre>
<p>
Adds a copy of the string <code>s</code> to the buffer <code>B</code> (see <a href="#luaL_Buffer"><code>luaL_Buffer</code></a>),
replacing any occurrence of the string <code>p</code>
with the string <code>r</code>.
<hr><h3><a name="luaL_addlstring"><code>luaL_addlstring</code></a></h3><p>
<span class="apii">[-?, +?, <em>m</em>]</span>
<pre>void luaL_addlstring (luaL_Buffer *B, const char *s, size_t l);</pre>
<p>
Adds the string pointed to by <code>s</code> with length <code>l</code> to
the buffer <code>B</code>
(see <a href="#luaL_Buffer"><code>luaL_Buffer</code></a>).
The string can contain embedded zeros.
<hr><h3><a name="luaL_addsize"><code>luaL_addsize</code></a></h3><p>
<span class="apii">[-?, +?, –]</span>
<pre>void luaL_addsize (luaL_Buffer *B, size_t n);</pre>
<p>
Adds to the buffer <code>B</code>
a string of length <code>n</code> previously copied to the
buffer area (see <a href="#luaL_prepbuffer"><code>luaL_prepbuffer</code></a>).
<hr><h3><a name="luaL_addstring"><code>luaL_addstring</code></a></h3><p>
<span class="apii">[-?, +?, <em>m</em>]</span>
<pre>void luaL_addstring (luaL_Buffer *B, const char *s);</pre>
<p>
Adds the zero-terminated string pointed to by <code>s</code>
to the buffer <code>B</code>
(see <a href="#luaL_Buffer"><code>luaL_Buffer</code></a>).
<hr><h3><a name="luaL_addvalue"><code>luaL_addvalue</code></a></h3><p>
<span class="apii">[-1, +?, <em>m</em>]</span>
<pre>void luaL_addvalue (luaL_Buffer *B);</pre>
<p>
Adds the value on the top of the stack
to the buffer <code>B</code>
(see <a href="#luaL_Buffer"><code>luaL_Buffer</code></a>).
Pops the value.
<p>
This is the only function on string buffers that can (and must)
be called with an extra element on the stack,
which is the value to be added to the buffer.
<hr><h3><a name="luaL_argcheck"><code>luaL_argcheck</code></a></h3><p>
<span class="apii">[-0, +0, <em>v</em>]</span>
<pre>void luaL_argcheck (lua_State *L,
int cond,
int arg,
const char *extramsg);</pre>
<p>
Checks whether <code>cond</code> is true.
If it is not, raises an error with a standard message (see <a href="#luaL_argerror"><code>luaL_argerror</code></a>).
<hr><h3><a name="luaL_argerror"><code>luaL_argerror</code></a></h3><p>
<span class="apii">[-0, +0, <em>v</em>]</span>
<pre>int luaL_argerror (lua_State *L, int arg, const char *extramsg);</pre>
<p>
Raises an error reporting a problem with argument <code>arg</code>
of the C function that called it,
using a standard message
that includes <code>extramsg</code> as a comment:
<pre>
bad argument #<em>arg</em> to '<em>funcname</em>' (<em>extramsg</em>)
</pre><p>
This function never returns.
<hr><h3><a name="luaL_argexpected"><code>luaL_argexpected</code></a></h3><p>
<span class="apii">[-0, +0, <em>v</em>]</span>
<pre>void luaL_argexpected (lua_State *L,
int cond,
int arg,
const char *tname);</pre>
<p>
Checks whether <code>cond</code> is true.
If it is not, raises an error about the type of the argument <code>arg</code>
with a standard message (see <a href="#luaL_typeerror"><code>luaL_typeerror</code></a>).
<hr><h3><a name="luaL_Buffer"><code>luaL_Buffer</code></a></h3>
<pre>typedef struct luaL_Buffer luaL_Buffer;</pre>
<p>
Type for a <em>string buffer</em>.
<p>
A string buffer allows C code to build Lua strings piecemeal.
Its pattern of use is as follows:
<ul>
<li>First declare a variable <code>b</code> of type <a href="#luaL_Buffer"><code>luaL_Buffer</code></a>.</li>
<li>Then initialize it with a call <code>luaL_buffinit(L, &b)</code>.</li>
<li>
Then add string pieces to the buffer calling any of
the <code>luaL_add*</code> functions.
</li>
<li>
Finish by calling <code>luaL_pushresult(&b)</code>.
This call leaves the final string on the top of the stack.
</li>
</ul>
<p>
If you know beforehand the maximum size of the resulting string,
you can use the buffer like this:
<ul>
<li>First declare a variable <code>b</code> of type <a href="#luaL_Buffer"><code>luaL_Buffer</code></a>.</li>
<li>Then initialize it and preallocate a space of
size <code>sz</code> with a call <code>luaL_buffinitsize(L, &b, sz)</code>.</li>
<li>Then produce the string into that space.</li>
<li>
Finish by calling <code>luaL_pushresultsize(&b, sz)</code>,
where <code>sz</code> is the total size of the resulting string
copied into that space (which may be less than or
equal to the preallocated size).
</li>
</ul>
<p>
During its normal operation,
a string buffer uses a variable number of stack slots.
So, while using a buffer, you cannot assume that you know where
the top of the stack is.
You can use the stack between successive calls to buffer operations
as long as that use is balanced;
that is,
when you call a buffer operation,
the stack is at the same level
it was immediately after the previous buffer operation.
(The only exception to this rule is <a href="#luaL_addvalue"><code>luaL_addvalue</code></a>.)
After calling <a href="#luaL_pushresult"><code>luaL_pushresult</code></a>,
the stack is back to its level when the buffer was initialized,
plus the final string on its top.
<hr><h3><a name="luaL_buffaddr"><code>luaL_buffaddr</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>char *luaL_buffaddr (luaL_Buffer *B);</pre>
<p>
Returns the address of the current content of buffer <code>B</code>
(see <a href="#luaL_Buffer"><code>luaL_Buffer</code></a>).
Note that any addition to the buffer may invalidate this address.
<hr><h3><a name="luaL_buffinit"><code>luaL_buffinit</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>void luaL_buffinit (lua_State *L, luaL_Buffer *B);</pre>
<p>
Initializes a buffer <code>B</code>
(see <a href="#luaL_Buffer"><code>luaL_Buffer</code></a>).
This function does not allocate any space;
the buffer must be declared as a variable.
<hr><h3><a name="luaL_bufflen"><code>luaL_bufflen</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>size_t luaL_bufflen (luaL_Buffer *B);</pre>
<p>
Returns the length of the current content of buffer <code>B</code>
(see <a href="#luaL_Buffer"><code>luaL_Buffer</code></a>).
<hr><h3><a name="luaL_buffinitsize"><code>luaL_buffinitsize</code></a></h3><p>
<span class="apii">[-?, +?, <em>m</em>]</span>
<pre>char *luaL_buffinitsize (lua_State *L, luaL_Buffer *B, size_t sz);</pre>
<p>
Equivalent to the sequence
<a href="#luaL_buffinit"><code>luaL_buffinit</code></a>, <a href="#luaL_prepbuffsize"><code>luaL_prepbuffsize</code></a>.
<hr><h3><a name="luaL_buffsub"><code>luaL_buffsub</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>void luaL_buffsub (luaL_Buffer *B, int n);</pre>
<p>
Removes <code>n</code> bytes from the the buffer <code>B</code>
(see <a href="#luaL_Buffer"><code>luaL_Buffer</code></a>).
The buffer must have at least that many bytes.
<hr><h3><a name="luaL_callmeta"><code>luaL_callmeta</code></a></h3><p>
<span class="apii">[-0, +(0|1), <em>e</em>]</span>
<pre>int luaL_callmeta (lua_State *L, int obj, const char *e);</pre>
<p>
Calls a metamethod.
<p>
If the object at index <code>obj</code> has a metatable and this
metatable has a field <code>e</code>,
this function calls this field passing the object as its only argument.
In this case this function returns true and pushes onto the
stack the value returned by the call.
If there is no metatable or no metamethod,
this function returns false without pushing any value on the stack.
<hr><h3><a name="luaL_checkany"><code>luaL_checkany</code></a></h3><p>
<span class="apii">[-0, +0, <em>v</em>]</span>
<pre>void luaL_checkany (lua_State *L, int arg);</pre>
<p>
Checks whether the function has an argument
of any type (including <b>nil</b>) at position <code>arg</code>.
<hr><h3><a name="luaL_checkinteger"><code>luaL_checkinteger</code></a></h3><p>
<span class="apii">[-0, +0, <em>v</em>]</span>
<pre>lua_Integer luaL_checkinteger (lua_State *L, int arg);</pre>
<p>
Checks whether the function argument <code>arg</code> is an integer
(or can be converted to an integer)
and returns this integer.
<hr><h3><a name="luaL_checklstring"><code>luaL_checklstring</code></a></h3><p>
<span class="apii">[-0, +0, <em>v</em>]</span>
<pre>const char *luaL_checklstring (lua_State *L, int arg, size_t *l);</pre>
<p>
Checks whether the function argument <code>arg</code> is a string
and returns this string;
if <code>l</code> is not <code>NULL</code> fills its referent
with the string's length.
<p>
This function uses <a href="#lua_tolstring"><code>lua_tolstring</code></a> to get its result,
so all conversions and caveats of that function apply here.
<hr><h3><a name="luaL_checknumber"><code>luaL_checknumber</code></a></h3><p>
<span class="apii">[-0, +0, <em>v</em>]</span>
<pre>lua_Number luaL_checknumber (lua_State *L, int arg);</pre>
<p>
Checks whether the function argument <code>arg</code> is a number
and returns this number converted to a <code>lua_Number</code>.
<hr><h3><a name="luaL_checkoption"><code>luaL_checkoption</code></a></h3><p>
<span class="apii">[-0, +0, <em>v</em>]</span>
<pre>int luaL_checkoption (lua_State *L,
int arg,
const char *def,
const char *const lst[]);</pre>
<p>
Checks whether the function argument <code>arg</code> is a string and
searches for this string in the array <code>lst</code>
(which must be NULL-terminated).
Returns the index in the array where the string was found.
Raises an error if the argument is not a string or
if the string cannot be found.
<p>
If <code>def</code> is not <code>NULL</code>,
the function uses <code>def</code> as a default value when
there is no argument <code>arg</code> or when this argument is <b>nil</b>.
<p>
This is a useful function for mapping strings to C enums.
(The usual convention in Lua libraries is
to use strings instead of numbers to select options.)
<hr><h3><a name="luaL_checkstack"><code>luaL_checkstack</code></a></h3><p>
<span class="apii">[-0, +0, <em>v</em>]</span>
<pre>void luaL_checkstack (lua_State *L, int sz, const char *msg);</pre>
<p>
Grows the stack size to <code>top + sz</code> elements,
raising an error if the stack cannot grow to that size.
<code>msg</code> is an additional text to go into the error message
(or <code>NULL</code> for no additional text).
<hr><h3><a name="luaL_checkstring"><code>luaL_checkstring</code></a></h3><p>
<span class="apii">[-0, +0, <em>v</em>]</span>
<pre>const char *luaL_checkstring (lua_State *L, int arg);</pre>
<p>
Checks whether the function argument <code>arg</code> is a string
and returns this string.
<p>
This function uses <a href="#lua_tolstring"><code>lua_tolstring</code></a> to get its result,
so all conversions and caveats of that function apply here.
<hr><h3><a name="luaL_checktype"><code>luaL_checktype</code></a></h3><p>
<span class="apii">[-0, +0, <em>v</em>]</span>
<pre>void luaL_checktype (lua_State *L, int arg, int t);</pre>
<p>
Checks whether the function argument <code>arg</code> has type <code>t</code>.
See <a href="#lua_type"><code>lua_type</code></a> for the encoding of types for <code>t</code>.
<hr><h3><a name="luaL_checkudata"><code>luaL_checkudata</code></a></h3><p>
<span class="apii">[-0, +0, <em>v</em>]</span>
<pre>void *luaL_checkudata (lua_State *L, int arg, const char *tname);</pre>
<p>
Checks whether the function argument <code>arg</code> is a userdata
of the type <code>tname</code> (see <a href="#luaL_newmetatable"><code>luaL_newmetatable</code></a>) and
returns the userdata's memory-block address (see <a href="#lua_touserdata"><code>lua_touserdata</code></a>).
<hr><h3><a name="luaL_checkversion"><code>luaL_checkversion</code></a></h3><p>
<span class="apii">[-0, +0, <em>v</em>]</span>
<pre>void luaL_checkversion (lua_State *L);</pre>
<p>
Checks whether the code making the call and the Lua library being called
are using the same version of Lua and the same numeric types.
<hr><h3><a name="luaL_dofile"><code>luaL_dofile</code></a></h3><p>
<span class="apii">[-0, +?, <em>m</em>]</span>
<pre>int luaL_dofile (lua_State *L, const char *filename);</pre>
<p>
Loads and runs the given file.
It is defined as the following macro:
<pre>
(luaL_loadfile(L, filename) || lua_pcall(L, 0, LUA_MULTRET, 0))
</pre><p>
It returns <a href="#pdf-LUA_OK"><code>LUA_OK</code></a> if there are no errors,
or an error code in case of errors (see <a href="#4.4.1">§4.4.1</a>).
<hr><h3><a name="luaL_dostring"><code>luaL_dostring</code></a></h3><p>
<span class="apii">[-0, +?, –]</span>
<pre>int luaL_dostring (lua_State *L, const char *str);</pre>
<p>
Loads and runs the given string.
It is defined as the following macro:
<pre>
(luaL_loadstring(L, str) || lua_pcall(L, 0, LUA_MULTRET, 0))
</pre><p>
It returns <a href="#pdf-LUA_OK"><code>LUA_OK</code></a> if there are no errors,
or an error code in case of errors (see <a href="#4.4.1">§4.4.1</a>).
<hr><h3><a name="luaL_error"><code>luaL_error</code></a></h3><p>
<span class="apii">[-0, +0, <em>v</em>]</span>
<pre>int luaL_error (lua_State *L, const char *fmt, ...);</pre>
<p>
Raises an error.
The error message format is given by <code>fmt</code>
plus any extra arguments,
following the same rules of <a href="#lua_pushfstring"><code>lua_pushfstring</code></a>.
It also adds at the beginning of the message the file name and
the line number where the error occurred,
if this information is available.
<p>
This function never returns,
but it is an idiom to use it in C functions
as <code>return luaL_error(<em>args</em>)</code>.
<hr><h3><a name="luaL_execresult"><code>luaL_execresult</code></a></h3><p>
<span class="apii">[-0, +3, <em>m</em>]</span>
<pre>int luaL_execresult (lua_State *L, int stat);</pre>
<p>
This function produces the return values for
process-related functions in the standard library
(<a href="#pdf-os.execute"><code>os.execute</code></a> and <a href="#pdf-io.close"><code>io.close</code></a>).
<hr><h3><a name="luaL_fileresult"><code>luaL_fileresult</code></a></h3><p>
<span class="apii">[-0, +(1|3), <em>m</em>]</span>
<pre>int luaL_fileresult (lua_State *L, int stat, const char *fname);</pre>
<p>
This function produces the return values for
file-related functions in the standard library
(<a href="#pdf-io.open"><code>io.open</code></a>, <a href="#pdf-os.rename"><code>os.rename</code></a>, <a href="#pdf-file:seek"><code>file:seek</code></a>, etc.).
<hr><h3><a name="luaL_getmetafield"><code>luaL_getmetafield</code></a></h3><p>
<span class="apii">[-0, +(0|1), <em>m</em>]</span>
<pre>int luaL_getmetafield (lua_State *L, int obj, const char *e);</pre>
<p>
Pushes onto the stack the field <code>e</code> from the metatable
of the object at index <code>obj</code> and returns the type of the pushed value.
If the object does not have a metatable,
or if the metatable does not have this field,
pushes nothing and returns <code>LUA_TNIL</code>.
<hr><h3><a name="luaL_getmetatable"><code>luaL_getmetatable</code></a></h3><p>
<span class="apii">[-0, +1, <em>m</em>]</span>
<pre>int luaL_getmetatable (lua_State *L, const char *tname);</pre>
<p>
Pushes onto the stack the metatable associated with the name <code>tname</code>
in the registry (see <a href="#luaL_newmetatable"><code>luaL_newmetatable</code></a>),
or <b>nil</b> if there is no metatable associated with that name.
Returns the type of the pushed value.
<hr><h3><a name="luaL_getsubtable"><code>luaL_getsubtable</code></a></h3><p>
<span class="apii">[-0, +1, <em>e</em>]</span>
<pre>int luaL_getsubtable (lua_State *L, int idx, const char *fname);</pre>
<p>
Ensures that the value <code>t[fname]</code>,
where <code>t</code> is the value at index <code>idx</code>,
is a table,
and pushes that table onto the stack.
Returns true if it finds a previous table there
and false if it creates a new table.
<hr><h3><a name="luaL_gsub"><code>luaL_gsub</code></a></h3><p>
<span class="apii">[-0, +1, <em>m</em>]</span>
<pre>const char *luaL_gsub (lua_State *L,
const char *s,
const char *p,
const char *r);</pre>
<p>
Creates a copy of string <code>s</code>,
replacing any occurrence of the string <code>p</code>
with the string <code>r</code>.
Pushes the resulting string on the stack and returns it.
<hr><h3><a name="luaL_len"><code>luaL_len</code></a></h3><p>
<span class="apii">[-0, +0, <em>e</em>]</span>
<pre>lua_Integer luaL_len (lua_State *L, int index);</pre>
<p>
Returns the "length" of the value at the given index
as a number;
it is equivalent to the '<code>#</code>' operator in Lua (see <a href="#3.4.7">§3.4.7</a>).
Raises an error if the result of the operation is not an integer.
(This case can only happen through metamethods.)
<hr><h3><a name="luaL_loadbuffer"><code>luaL_loadbuffer</code></a></h3><p>
<span class="apii">[-0, +1, –]</span>
<pre>int luaL_loadbuffer (lua_State *L,
const char *buff,
size_t sz,
const char *name);</pre>
<p>
Equivalent to <a href="#luaL_loadbufferx"><code>luaL_loadbufferx</code></a> with <code>mode</code> equal to <code>NULL</code>.
<hr><h3><a name="luaL_loadbufferx"><code>luaL_loadbufferx</code></a></h3><p>
<span class="apii">[-0, +1, –]</span>
<pre>int luaL_loadbufferx (lua_State *L,
const char *buff,
size_t sz,
const char *name,
const char *mode);</pre>
<p>
Loads a buffer as a Lua chunk.
This function uses <a href="#lua_load"><code>lua_load</code></a> to load the chunk in the
buffer pointed to by <code>buff</code> with size <code>sz</code>.
<p>
This function returns the same results as <a href="#lua_load"><code>lua_load</code></a>.
<code>name</code> is the chunk name,
used for debug information and error messages.
The string <code>mode</code> works as in the function <a href="#lua_load"><code>lua_load</code></a>.
<hr><h3><a name="luaL_loadfile"><code>luaL_loadfile</code></a></h3><p>
<span class="apii">[-0, +1, <em>m</em>]</span>
<pre>int luaL_loadfile (lua_State *L, const char *filename);</pre>
<p>
Equivalent to <a href="#luaL_loadfilex"><code>luaL_loadfilex</code></a> with <code>mode</code> equal to <code>NULL</code>.
<hr><h3><a name="luaL_loadfilex"><code>luaL_loadfilex</code></a></h3><p>
<span class="apii">[-0, +1, <em>m</em>]</span>
<pre>int luaL_loadfilex (lua_State *L, const char *filename,
const char *mode);</pre>
<p>
Loads a file as a Lua chunk.
This function uses <a href="#lua_load"><code>lua_load</code></a> to load the chunk in the file
named <code>filename</code>.
If <code>filename</code> is <code>NULL</code>,
then it loads from the standard input.
The first line in the file is ignored if it starts with a <code>#</code>.
<p>
The string <code>mode</code> works as in the function <a href="#lua_load"><code>lua_load</code></a>.
<p>
This function returns the same results as <a href="#lua_load"><code>lua_load</code></a>
or <a href="#pdf-LUA_ERRFILE"><code>LUA_ERRFILE</code></a> for file-related errors.
<p>
As <a href="#lua_load"><code>lua_load</code></a>, this function only loads the chunk;
it does not run it.
<hr><h3><a name="luaL_loadstring"><code>luaL_loadstring</code></a></h3><p>
<span class="apii">[-0, +1, –]</span>
<pre>int luaL_loadstring (lua_State *L, const char *s);</pre>
<p>
Loads a string as a Lua chunk.
This function uses <a href="#lua_load"><code>lua_load</code></a> to load the chunk in
the zero-terminated string <code>s</code>.
<p>
This function returns the same results as <a href="#lua_load"><code>lua_load</code></a>.
<p>
Also as <a href="#lua_load"><code>lua_load</code></a>, this function only loads the chunk;
it does not run it.
<hr><h3><a name="luaL_newlib"><code>luaL_newlib</code></a></h3><p>
<span class="apii">[-0, +1, <em>m</em>]</span>
<pre>void luaL_newlib (lua_State *L, const luaL_Reg l[]);</pre>
<p>
Creates a new table and registers there
the functions in the list <code>l</code>.
<p>
It is implemented as the following macro:
<pre>
(luaL_newlibtable(L,l), luaL_setfuncs(L,l,0))
</pre><p>
The array <code>l</code> must be the actual array,
not a pointer to it.
<hr><h3><a name="luaL_newlibtable"><code>luaL_newlibtable</code></a></h3><p>
<span class="apii">[-0, +1, <em>m</em>]</span>
<pre>void luaL_newlibtable (lua_State *L, const luaL_Reg l[]);</pre>
<p>
Creates a new table with a size optimized
to store all entries in the array <code>l</code>
(but does not actually store them).
It is intended to be used in conjunction with <a href="#luaL_setfuncs"><code>luaL_setfuncs</code></a>
(see <a href="#luaL_newlib"><code>luaL_newlib</code></a>).
<p>
It is implemented as a macro.
The array <code>l</code> must be the actual array,
not a pointer to it.
<hr><h3><a name="luaL_newmetatable"><code>luaL_newmetatable</code></a></h3><p>
<span class="apii">[-0, +1, <em>m</em>]</span>
<pre>int luaL_newmetatable (lua_State *L, const char *tname);</pre>
<p>
If the registry already has the key <code>tname</code>,
returns 0.
Otherwise,
creates a new table to be used as a metatable for userdata,
adds to this new table the pair <code>__name = tname</code>,
adds to the registry the pair <code>[tname] = new table</code>,
and returns 1.
<p>
In both cases,
the function pushes onto the stack the final value associated
with <code>tname</code> in the registry.
<hr><h3><a name="luaL_newstate"><code>luaL_newstate</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>lua_State *luaL_newstate (void);</pre>
<p>
Creates a new Lua state.
It calls <a href="#lua_newstate"><code>lua_newstate</code></a> with an
allocator based on the standard C allocation functions
and then sets a warning function and a panic function (see <a href="#4.4">§4.4</a>)
that print messages to the standard error output.
<p>
Returns the new state,
or <code>NULL</code> if there is a memory allocation error.
<hr><h3><a name="luaL_openlibs"><code>luaL_openlibs</code></a></h3><p>
<span class="apii">[-0, +0, <em>e</em>]</span>
<pre>void luaL_openlibs (lua_State *L);</pre>
<p>
Opens all standard Lua libraries into the given state.
<hr><h3><a name="luaL_opt"><code>luaL_opt</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>T luaL_opt (L, func, arg, dflt);</pre>
<p>
This macro is defined as follows:
<pre>
(lua_isnoneornil(L,(arg)) ? (dflt) : func(L,(arg)))
</pre><p>
In words, if the argument <code>arg</code> is nil or absent,
the macro results in the default <code>dflt</code>.
Otherwise, it results in the result of calling <code>func</code>
with the state <code>L</code> and the argument index <code>arg</code> as
arguments.
Note that it evaluates the expression <code>dflt</code> only if needed.
<hr><h3><a name="luaL_optinteger"><code>luaL_optinteger</code></a></h3><p>
<span class="apii">[-0, +0, <em>v</em>]</span>
<pre>lua_Integer luaL_optinteger (lua_State *L,
int arg,
lua_Integer d);</pre>
<p>
If the function argument <code>arg</code> is an integer
(or it is convertible to an integer),
returns this integer.
If this argument is absent or is <b>nil</b>,
returns <code>d</code>.
Otherwise, raises an error.
<hr><h3><a name="luaL_optlstring"><code>luaL_optlstring</code></a></h3><p>
<span class="apii">[-0, +0, <em>v</em>]</span>
<pre>const char *luaL_optlstring (lua_State *L,
int arg,
const char *d,
size_t *l);</pre>
<p>
If the function argument <code>arg</code> is a string,
returns this string.
If this argument is absent or is <b>nil</b>,
returns <code>d</code>.
Otherwise, raises an error.
<p>
If <code>l</code> is not <code>NULL</code>,
fills its referent with the result's length.
If the result is <code>NULL</code>
(only possible when returning <code>d</code> and <code>d == NULL</code>),
its length is considered zero.
<p>
This function uses <a href="#lua_tolstring"><code>lua_tolstring</code></a> to get its result,
so all conversions and caveats of that function apply here.
<hr><h3><a name="luaL_optnumber"><code>luaL_optnumber</code></a></h3><p>
<span class="apii">[-0, +0, <em>v</em>]</span>
<pre>lua_Number luaL_optnumber (lua_State *L, int arg, lua_Number d);</pre>
<p>
If the function argument <code>arg</code> is a number,
returns this number as a <code>lua_Number</code>.
If this argument is absent or is <b>nil</b>,
returns <code>d</code>.
Otherwise, raises an error.
<hr><h3><a name="luaL_optstring"><code>luaL_optstring</code></a></h3><p>
<span class="apii">[-0, +0, <em>v</em>]</span>
<pre>const char *luaL_optstring (lua_State *L,
int arg,
const char *d);</pre>
<p>
If the function argument <code>arg</code> is a string,
returns this string.
If this argument is absent or is <b>nil</b>,
returns <code>d</code>.
Otherwise, raises an error.
<hr><h3><a name="luaL_prepbuffer"><code>luaL_prepbuffer</code></a></h3><p>
<span class="apii">[-?, +?, <em>m</em>]</span>
<pre>char *luaL_prepbuffer (luaL_Buffer *B);</pre>
<p>
Equivalent to <a href="#luaL_prepbuffsize"><code>luaL_prepbuffsize</code></a>
with the predefined size <a name="pdf-LUAL_BUFFERSIZE"><code>LUAL_BUFFERSIZE</code></a>.
<hr><h3><a name="luaL_prepbuffsize"><code>luaL_prepbuffsize</code></a></h3><p>
<span class="apii">[-?, +?, <em>m</em>]</span>
<pre>char *luaL_prepbuffsize (luaL_Buffer *B, size_t sz);</pre>
<p>
Returns an address to a space of size <code>sz</code>
where you can copy a string to be added to buffer <code>B</code>
(see <a href="#luaL_Buffer"><code>luaL_Buffer</code></a>).
After copying the string into this space you must call
<a href="#luaL_addsize"><code>luaL_addsize</code></a> with the size of the string to actually add
it to the buffer.
<hr><h3><a name="luaL_pushfail"><code>luaL_pushfail</code></a></h3><p>
<span class="apii">[-0, +1, –]</span>
<pre>void luaL_pushfail (lua_State *L);</pre>
<p>
Pushes the <b>fail</b> value onto the stack (see <a href="#6">§6</a>).
<hr><h3><a name="luaL_pushresult"><code>luaL_pushresult</code></a></h3><p>
<span class="apii">[-?, +1, <em>m</em>]</span>
<pre>void luaL_pushresult (luaL_Buffer *B);</pre>
<p>
Finishes the use of buffer <code>B</code> leaving the final string on
the top of the stack.
<hr><h3><a name="luaL_pushresultsize"><code>luaL_pushresultsize</code></a></h3><p>
<span class="apii">[-?, +1, <em>m</em>]</span>
<pre>void luaL_pushresultsize (luaL_Buffer *B, size_t sz);</pre>
<p>
Equivalent to the sequence <a href="#luaL_addsize"><code>luaL_addsize</code></a>, <a href="#luaL_pushresult"><code>luaL_pushresult</code></a>.
<hr><h3><a name="luaL_ref"><code>luaL_ref</code></a></h3><p>
<span class="apii">[-1, +0, <em>m</em>]</span>
<pre>int luaL_ref (lua_State *L, int t);</pre>
<p>
Creates and returns a <em>reference</em>,
in the table at index <code>t</code>,
for the object on the top of the stack (and pops the object).
<p>
A reference is a unique integer key.
As long as you do not manually add integer keys into the table <code>t</code>,
<a href="#luaL_ref"><code>luaL_ref</code></a> ensures the uniqueness of the key it returns.
You can retrieve an object referred by the reference <code>r</code>
by calling <code>lua_rawgeti(L, t, r)</code>.
The function <a href="#luaL_unref"><code>luaL_unref</code></a> frees a reference.
<p>
If the object on the top of the stack is <b>nil</b>,
<a href="#luaL_ref"><code>luaL_ref</code></a> returns the constant <a name="pdf-LUA_REFNIL"><code>LUA_REFNIL</code></a>.
The constant <a name="pdf-LUA_NOREF"><code>LUA_NOREF</code></a> is guaranteed to be different
from any reference returned by <a href="#luaL_ref"><code>luaL_ref</code></a>.
<hr><h3><a name="luaL_Reg"><code>luaL_Reg</code></a></h3>
<pre>typedef struct luaL_Reg {
const char *name;
lua_CFunction func;
} luaL_Reg;</pre>
<p>
Type for arrays of functions to be registered by
<a href="#luaL_setfuncs"><code>luaL_setfuncs</code></a>.
<code>name</code> is the function name and <code>func</code> is a pointer to
the function.
Any array of <a href="#luaL_Reg"><code>luaL_Reg</code></a> must end with a sentinel entry
in which both <code>name</code> and <code>func</code> are <code>NULL</code>.
<hr><h3><a name="luaL_requiref"><code>luaL_requiref</code></a></h3><p>
<span class="apii">[-0, +1, <em>e</em>]</span>
<pre>void luaL_requiref (lua_State *L, const char *modname,
lua_CFunction openf, int glb);</pre>
<p>
If <code>package.loaded[modname]</code> is not true,
calls the function <code>openf</code> with the string <code>modname</code> as an argument
and sets the call result to <code>package.loaded[modname]</code>,
as if that function has been called through <a href="#pdf-require"><code>require</code></a>.
<p>
If <code>glb</code> is true,
also stores the module into the global <code>modname</code>.
<p>
Leaves a copy of the module on the stack.
<hr><h3><a name="luaL_setfuncs"><code>luaL_setfuncs</code></a></h3><p>
<span class="apii">[-nup, +0, <em>m</em>]</span>
<pre>void luaL_setfuncs (lua_State *L, const luaL_Reg *l, int nup);</pre>
<p>
Registers all functions in the array <code>l</code>
(see <a href="#luaL_Reg"><code>luaL_Reg</code></a>) into the table on the top of the stack
(below optional upvalues, see next).
<p>
When <code>nup</code> is not zero,
all functions are created with <code>nup</code> upvalues,
initialized with copies of the <code>nup</code> values
previously pushed on the stack
on top of the library table.
These values are popped from the stack after the registration.
<hr><h3><a name="luaL_setmetatable"><code>luaL_setmetatable</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>void luaL_setmetatable (lua_State *L, const char *tname);</pre>
<p>
Sets the metatable of the object on the top of the stack
as the metatable associated with name <code>tname</code>
in the registry (see <a href="#luaL_newmetatable"><code>luaL_newmetatable</code></a>).
<hr><h3><a name="luaL_Stream"><code>luaL_Stream</code></a></h3>
<pre>typedef struct luaL_Stream {
FILE *f;
lua_CFunction closef;
} luaL_Stream;</pre>
<p>
The standard representation for file handles
used by the standard I/O library.
<p>
A file handle is implemented as a full userdata,
with a metatable called <code>LUA_FILEHANDLE</code>
(where <code>LUA_FILEHANDLE</code> is a macro with the actual metatable's name).
The metatable is created by the I/O library
(see <a href="#luaL_newmetatable"><code>luaL_newmetatable</code></a>).
<p>
This userdata must start with the structure <code>luaL_Stream</code>;
it can contain other data after this initial structure.
The field <code>f</code> points to the corresponding C stream
(or it can be <code>NULL</code> to indicate an incompletely created handle).
The field <code>closef</code> points to a Lua function
that will be called to close the stream
when the handle is closed or collected;
this function receives the file handle as its sole argument and
must return either a true value, in case of success,
or a false value plus an error message, in case of error.
Once Lua calls this field,
it changes the field value to <code>NULL</code>
to signal that the handle is closed.
<hr><h3><a name="luaL_testudata"><code>luaL_testudata</code></a></h3><p>
<span class="apii">[-0, +0, <em>m</em>]</span>
<pre>void *luaL_testudata (lua_State *L, int arg, const char *tname);</pre>
<p>
This function works like <a href="#luaL_checkudata"><code>luaL_checkudata</code></a>,
except that, when the test fails,
it returns <code>NULL</code> instead of raising an error.
<hr><h3><a name="luaL_tolstring"><code>luaL_tolstring</code></a></h3><p>
<span class="apii">[-0, +1, <em>e</em>]</span>
<pre>const char *luaL_tolstring (lua_State *L, int idx, size_t *len);</pre>
<p>
Converts any Lua value at the given index to a C string
in a reasonable format.
The resulting string is pushed onto the stack and also
returned by the function (see <a href="#4.1.3">§4.1.3</a>).
If <code>len</code> is not <code>NULL</code>,
the function also sets <code>*len</code> with the string length.
<p>
If the value has a metatable with a <code>__tostring</code> field,
then <code>luaL_tolstring</code> calls the corresponding metamethod
with the value as argument,
and uses the result of the call as its result.
<hr><h3><a name="luaL_traceback"><code>luaL_traceback</code></a></h3><p>
<span class="apii">[-0, +1, <em>m</em>]</span>
<pre>void luaL_traceback (lua_State *L, lua_State *L1, const char *msg,
int level);</pre>
<p>
Creates and pushes a traceback of the stack <code>L1</code>.
If <code>msg</code> is not <code>NULL</code>, it is appended
at the beginning of the traceback.
The <code>level</code> parameter tells at which level
to start the traceback.
<hr><h3><a name="luaL_typeerror"><code>luaL_typeerror</code></a></h3><p>
<span class="apii">[-0, +0, <em>v</em>]</span>
<pre>const char *luaL_typeerror (lua_State *L,
int arg,
const char *tname);</pre>
<p>
Raises a type error for the argument <code>arg</code>
of the C function that called it,
using a standard message;
<code>tname</code> is a "name" for the expected type.
This function never returns.
<hr><h3><a name="luaL_typename"><code>luaL_typename</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>const char *luaL_typename (lua_State *L, int index);</pre>
<p>
Returns the name of the type of the value at the given index.
<hr><h3><a name="luaL_unref"><code>luaL_unref</code></a></h3><p>
<span class="apii">[-0, +0, –]</span>
<pre>void luaL_unref (lua_State *L, int t, int ref);</pre>
<p>
Releases the reference <code>ref</code> from the table at index <code>t</code>
(see <a href="#luaL_ref"><code>luaL_ref</code></a>).
The entry is removed from the table,
so that the referred object can be collected.
The reference <code>ref</code> is also freed to be used again.
<p>
If <code>ref</code> is <a href="#pdf-LUA_NOREF"><code>LUA_NOREF</code></a> or <a href="#pdf-LUA_REFNIL"><code>LUA_REFNIL</code></a>,
<a href="#luaL_unref"><code>luaL_unref</code></a> does nothing.
<hr><h3><a name="luaL_where"><code>luaL_where</code></a></h3><p>
<span class="apii">[-0, +1, <em>m</em>]</span>
<pre>void luaL_where (lua_State *L, int lvl);</pre>
<p>
Pushes onto the stack a string identifying the current position
of the control at level <code>lvl</code> in the call stack.
Typically this string has the following format:
<pre>
<em>chunkname</em>:<em>currentline</em>:
</pre><p>
Level 0 is the running function,
level 1 is the function that called the running function,
etc.
<p>
This function is used to build a prefix for error messages.
<h1>6 – <a name="6">The Standard Libraries</a></h1>
<p>
The standard Lua libraries provide useful functions
that are implemented in C through the C API.
Some of these functions provide essential services to the language
(e.g., <a href="#pdf-type"><code>type</code></a> and <a href="#pdf-getmetatable"><code>getmetatable</code></a>);
others provide access to outside services (e.g., I/O);
and others could be implemented in Lua itself,
but that for different reasons
deserve an implementation in C (e.g., <a href="#pdf-table.sort"><code>table.sort</code></a>).
<p>
All libraries are implemented through the official C API
and are provided as separate C modules.
Unless otherwise noted,
these library functions do not adjust its number of arguments
to its expected parameters.
For instance, a function documented as <code>foo(arg)</code>
should not be called without an argument.
<p>
The notation <b>fail</b> means a false value representing
some kind of failure.
(Currently, <b>fail</b> is equal to <b>nil</b>,
but that may change in future versions.
The recommendation is to always test the success of these functions
with <code>(not status)</code>, instead of <code>(status == nil)</code>.)
<p>
Currently, Lua has the following standard libraries:
<ul>
<li>basic library (<a href="#6.1">§6.1</a>);</li>
<li>coroutine library (<a href="#6.2">§6.2</a>);</li>
<li>package library (<a href="#6.3">§6.3</a>);</li>
<li>string manipulation (<a href="#6.4">§6.4</a>);</li>
<li>basic UTF-8 support (<a href="#6.5">§6.5</a>);</li>
<li>table manipulation (<a href="#6.6">§6.6</a>);</li>
<li>mathematical functions (<a href="#6.7">§6.7</a>) (sin, log, etc.);</li>
<li>input and output (<a href="#6.8">§6.8</a>);</li>
<li>operating system facilities (<a href="#6.9">§6.9</a>);</li>
<li>debug facilities (<a href="#6.10">§6.10</a>).</li>
</ul><p>
Except for the basic and the package libraries,
each library provides all its functions as fields of a global table
or as methods of its objects.
<p>
To have access to these libraries,
the C host program should call the <a href="#luaL_openlibs"><code>luaL_openlibs</code></a> function,
which opens all standard libraries.
Alternatively,
the host program can open them individually by using
<a href="#luaL_requiref"><code>luaL_requiref</code></a> to call
<a name="pdf-luaopen_base"><code>luaopen_base</code></a> (for the basic library),
<a name="pdf-luaopen_package"><code>luaopen_package</code></a> (for the package library),
<a name="pdf-luaopen_coroutine"><code>luaopen_coroutine</code></a> (for the coroutine library),
<a name="pdf-luaopen_string"><code>luaopen_string</code></a> (for the string library),
<a name="pdf-luaopen_utf8"><code>luaopen_utf8</code></a> (for the UTF-8 library),
<a name="pdf-luaopen_table"><code>luaopen_table</code></a> (for the table library),
<a name="pdf-luaopen_math"><code>luaopen_math</code></a> (for the mathematical library),
<a name="pdf-luaopen_io"><code>luaopen_io</code></a> (for the I/O library),
<a name="pdf-luaopen_os"><code>luaopen_os</code></a> (for the operating system library),
and <a name="pdf-luaopen_debug"><code>luaopen_debug</code></a> (for the debug library).
These functions are declared in <a name="pdf-lualib.h"><code>lualib.h</code></a>.
<h2>6.1 – <a name="6.1">Basic Functions</a></h2>
<p>
The basic library provides core functions to Lua.
If you do not include this library in your application,
you should check carefully whether you need to provide
implementations for some of its facilities.
<p>
<hr><h3><a name="pdf-assert"><code>assert (v [, message])</code></a></h3>
<p>
Raises an error if
the value of its argument <code>v</code> is false (i.e., <b>nil</b> or <b>false</b>);
otherwise, returns all its arguments.
In case of error,
<code>message</code> is the error object;
when absent, it defaults to "<code>assertion failed!</code>"
<p>
<hr><h3><a name="pdf-collectgarbage"><code>collectgarbage ([opt [, arg]])</code></a></h3>
<p>
This function is a generic interface to the garbage collector.
It performs different functions according to its first argument, <code>opt</code>:
<ul>
<li><b>"<code>collect</code>": </b>
Performs a full garbage-collection cycle.
This is the default option.
</li>
<li><b>"<code>stop</code>": </b>
Stops automatic execution of the garbage collector.
The collector will run only when explicitly invoked,
until a call to restart it.
</li>
<li><b>"<code>restart</code>": </b>
Restarts automatic execution of the garbage collector.
</li>
<li><b>"<code>count</code>": </b>
Returns the total memory in use by Lua in Kbytes.
The value has a fractional part,
so that it multiplied by 1024
gives the exact number of bytes in use by Lua.
</li>
<li><b>"<code>step</code>": </b>
Performs a garbage-collection step.
The step "size" is controlled by <code>arg</code>.
With a zero value,
the collector will perform one basic (indivisible) step.
For non-zero values,
the collector will perform as if that amount of memory
(in Kbytes) had been allocated by Lua.
Returns <b>true</b> if the step finished a collection cycle.
</li>
<li><b>"<code>isrunning</code>": </b>
Returns a boolean that tells whether the collector is running
(i.e., not stopped).
</li>
<li><b>"<code>incremental</code>": </b>
Change the collector mode to incremental.
This option can be followed by three numbers:
the garbage-collector pause,
the step multiplier,
and the step size (see <a href="#2.5.1">§2.5.1</a>).
A zero means to not change that value.
</li>
<li><b>"<code>generational</code>": </b>
Change the collector mode to generational.
This option can be followed by two numbers:
the garbage-collector minor multiplier
and the major multiplier (see <a href="#2.5.2">§2.5.2</a>).
A zero means to not change that value.
</li>
</ul><p>
See <a href="#2.5">§2.5</a> for more details about garbage collection
and some of these options.
<p>
<hr><h3><a name="pdf-dofile"><code>dofile ([filename])</code></a></h3>
Opens the named file and executes its content as a Lua chunk.
When called without arguments,
<code>dofile</code> executes the content of the standard input (<code>stdin</code>).
Returns all values returned by the chunk.
In case of errors, <code>dofile</code> propagates the error
to its caller.
(That is, <code>dofile</code> does not run in protected mode.)
<p>
<hr><h3><a name="pdf-error"><code>error (message [, level])</code></a></h3>
Raises an error (see <a href="#2.3">§2.3</a>) with @{message} as the error object.
This function never returns.
<p>
Usually, <code>error</code> adds some information about the error position
at the beginning of the message, if the message is a string.
The <code>level</code> argument specifies how to get the error position.
With level 1 (the default), the error position is where the
<code>error</code> function was called.
Level 2 points the error to where the function
that called <code>error</code> was called; and so on.
Passing a level 0 avoids the addition of error position information
to the message.
<p>
<hr><h3><a name="pdf-_G"><code>_G</code></a></h3>
A global variable (not a function) that
holds the global environment (see <a href="#2.2">§2.2</a>).
Lua itself does not use this variable;
changing its value does not affect any environment,
nor vice versa.
<p>
<hr><h3><a name="pdf-getmetatable"><code>getmetatable (object)</code></a></h3>
<p>
If <code>object</code> does not have a metatable, returns <b>nil</b>.
Otherwise,
if the object's metatable has a <code>__metatable</code> field,
returns the associated value.
Otherwise, returns the metatable of the given object.
<p>
<hr><h3><a name="pdf-ipairs"><code>ipairs (t)</code></a></h3>
<p>
Returns three values (an iterator function, the table <code>t</code>, and 0)
so that the construction
<pre>
for i,v in ipairs(t) do <em>body</em> end
</pre><p>
will iterate over the key–value pairs
(<code>1,t[1]</code>), (<code>2,t[2]</code>), ...,
up to the first absent index.
<p>
<hr><h3><a name="pdf-load"><code>load (chunk [, chunkname [, mode [, env]]])</code></a></h3>
<p>
Loads a chunk.
<p>
If <code>chunk</code> is a string, the chunk is this string.
If <code>chunk</code> is a function,
<code>load</code> calls it repeatedly to get the chunk pieces.
Each call to <code>chunk</code> must return a string that concatenates
with previous results.
A return of an empty string, <b>nil</b>, or no value signals the end of the chunk.
<p>
If there are no syntactic errors,
<code>load</code> returns the compiled chunk as a function;
otherwise, it returns <b>fail</b> plus the error message.
<p>
When you load a main chunk,
the resulting function will always have exactly one upvalue,
the <code>_ENV</code> variable (see <a href="#2.2">§2.2</a>).
However,
when you load a binary chunk created from a function (see <a href="#pdf-string.dump"><code>string.dump</code></a>),
the resulting function can have an arbitrary number of upvalues,
and there is no guarantee that its first upvalue will be
the <code>_ENV</code> variable.
(A non-main function may not even have an <code>_ENV</code> upvalue.)
<p>
Regardless, if the resulting function has any upvalues,
its first upvalue is set to the value of <code>env</code>,
if that parameter is given,
or to the value of the global environment.
Other upvalues are initialized with <b>nil</b>.
All upvalues are fresh, that is,
they are not shared with any other function.
<p>
<code>chunkname</code> is used as the name of the chunk for error messages
and debug information (see <a href="#4.7">§4.7</a>).
When absent,
it defaults to <code>chunk</code>, if <code>chunk</code> is a string,
or to "<code>=(load)</code>" otherwise.
<p>
The string <code>mode</code> controls whether the chunk can be text or binary
(that is, a precompiled chunk).
It may be the string "<code>b</code>" (only binary chunks),
"<code>t</code>" (only text chunks),
or "<code>bt</code>" (both binary and text).
The default is "<code>bt</code>".
<p>
It is safe to load malformed binary chunks;
<code>load</code> signals an appropriate error.
However,
Lua does not check the consistency of the code inside binary chunks;
running maliciously crafted bytecode can crash the interpreter.
<p>
<hr><h3><a name="pdf-loadfile"><code>loadfile ([filename [, mode [, env]]])</code></a></h3>
<p>
Similar to <a href="#pdf-load"><code>load</code></a>,
but gets the chunk from file <code>filename</code>
or from the standard input,
if no file name is given.
<p>
<hr><h3><a name="pdf-next"><code>next (table [, index])</code></a></h3>
<p>
Allows a program to traverse all fields of a table.
Its first argument is a table and its second argument
is an index in this table.
A call to <code>next</code> returns the next index of the table
and its associated value.
When called with <b>nil</b> as its second argument,
<code>next</code> returns an initial index
and its associated value.
When called with the last index,
or with <b>nil</b> in an empty table,
<code>next</code> returns <b>nil</b>.
If the second argument is absent, then it is interpreted as <b>nil</b>.
In particular,
you can use <code>next(t)</code> to check whether a table is empty.
<p>
The order in which the indices are enumerated is not specified,
<em>even for numeric indices</em>.
(To traverse a table in numerical order,
use a numerical <b>for</b>.)
<p>
The behavior of <code>next</code> is undefined if,
during the traversal,
you assign any value to a non-existent field in the table.
You may however modify existing fields.
In particular, you may set existing fields to nil.
<p>
<hr><h3><a name="pdf-pairs"><code>pairs (t)</code></a></h3>
<p>
If <code>t</code> has a metamethod <code>__pairs</code>,
calls it with <code>t</code> as argument and returns the first three
results from the call.
<p>
Otherwise,
returns three values: the <a href="#pdf-next"><code>next</code></a> function, the table <code>t</code>, and <b>nil</b>,
so that the construction
<pre>
for k,v in pairs(t) do <em>body</em> end
</pre><p>
will iterate over all key–value pairs of table <code>t</code>.
<p>
See function <a href="#pdf-next"><code>next</code></a> for the caveats of modifying
the table during its traversal.
<p>
<hr><h3><a name="pdf-pcall"><code>pcall (f [, arg1, ···])</code></a></h3>
<p>
Calls the function <code>f</code> with
the given arguments in <em>protected mode</em>.
This means that any error inside <code>f</code> is not propagated;
instead, <code>pcall</code> catches the error
and returns a status code.
Its first result is the status code (a boolean),
which is true if the call succeeds without errors.
In such case, <code>pcall</code> also returns all results from the call,
after this first result.
In case of any error, <code>pcall</code> returns <b>false</b> plus the error object.
Note that errors caught by <code>pcall</code> do not call a message handler.
<p>
<hr><h3><a name="pdf-print"><code>print (···)</code></a></h3>
Receives any number of arguments
and prints their values to <code>stdout</code>,
converting each argument to a string
following the same rules of <a href="#pdf-tostring"><code>tostring</code></a>.
<p>
The function <code>print</code> is not intended for formatted output,
but only as a quick way to show a value,
for instance for debugging.
For complete control over the output,
use <a href="#pdf-string.format"><code>string.format</code></a> and <a href="#pdf-io.write"><code>io.write</code></a>.
<p>
<hr><h3><a name="pdf-rawequal"><code>rawequal (v1, v2)</code></a></h3>
Checks whether <code>v1</code> is equal to <code>v2</code>,
without invoking the <code>__eq</code> metamethod.
Returns a boolean.
<p>
<hr><h3><a name="pdf-rawget"><code>rawget (table, index)</code></a></h3>
Gets the real value of <code>table[index]</code>,
without using the <code>__index</code> metavalue.
<code>table</code> must be a table;
<code>index</code> may be any value.
<p>
<hr><h3><a name="pdf-rawlen"><code>rawlen (v)</code></a></h3>
Returns the length of the object <code>v</code>,
which must be a table or a string,
without invoking the <code>__len</code> metamethod.
Returns an integer.
<p>
<hr><h3><a name="pdf-rawset"><code>rawset (table, index, value)</code></a></h3>
Sets the real value of <code>table[index]</code> to <code>value</code>,
without using the <code>__newindex</code> metavalue.
<code>table</code> must be a table,
<code>index</code> any value different from <b>nil</b> and NaN,
and <code>value</code> any Lua value.
<p>
This function returns <code>table</code>.
<p>
<hr><h3><a name="pdf-select"><code>select (index, ···)</code></a></h3>
<p>
If <code>index</code> is a number,
returns all arguments after argument number <code>index</code>;
a negative number indexes from the end (-1 is the last argument).
Otherwise, <code>index</code> must be the string <code>"#"</code>,
and <code>select</code> returns the total number of extra arguments it received.
<p>
<hr><h3><a name="pdf-setmetatable"><code>setmetatable (table, metatable)</code></a></h3>
<p>
Sets the metatable for the given table.
If <code>metatable</code> is <b>nil</b>,
removes the metatable of the given table.
If the original metatable has a <code>__metatable</code> field,
raises an error.
<p>
This function returns <code>table</code>.
<p>
To change the metatable of other types from Lua code,
you must use the debug library (<a href="#6.10">§6.10</a>).
<p>
<hr><h3><a name="pdf-tonumber"><code>tonumber (e [, base])</code></a></h3>
<p>
When called with no <code>base</code>,
<code>tonumber</code> tries to convert its argument to a number.
If the argument is already a number or
a string convertible to a number,
then <code>tonumber</code> returns this number;
otherwise, it returns <b>fail</b>.
<p>
The conversion of strings can result in integers or floats,
according to the lexical conventions of Lua (see <a href="#3.1">§3.1</a>).
The string may have leading and trailing spaces and a sign.
<p>
When called with <code>base</code>,
then <code>e</code> must be a string to be interpreted as
an integer numeral in that base.
The base may be any integer between 2 and 36, inclusive.
In bases above 10, the letter '<code>A</code>' (in either upper or lower case)
represents 10, '<code>B</code>' represents 11, and so forth,
with '<code>Z</code>' representing 35.
If the string <code>e</code> is not a valid numeral in the given base,
the function returns <b>fail</b>.
<p>
<hr><h3><a name="pdf-tostring"><code>tostring (v)</code></a></h3>
<p>
Receives a value of any type and
converts it to a string in a human-readable format.
<p>
If the metatable of <code>v</code> has a <code>__tostring</code> field,
then <code>tostring</code> calls the corresponding value
with <code>v</code> as argument,
and uses the result of the call as its result.
Otherwise, if the metatable of <code>v</code> has a <code>__name</code> field
with a string value,
<code>tostring</code> may use that string in its final result.
<p>
For complete control of how numbers are converted,
use <a href="#pdf-string.format"><code>string.format</code></a>.
<p>
<hr><h3><a name="pdf-type"><code>type (v)</code></a></h3>
<p>
Returns the type of its only argument, coded as a string.
The possible results of this function are
"<code>nil</code>" (a string, not the value <b>nil</b>),
"<code>number</code>",
"<code>string</code>",
"<code>boolean</code>",
"<code>table</code>",
"<code>function</code>",
"<code>thread</code>",
and "<code>userdata</code>".
<p>
<hr><h3><a name="pdf-_VERSION"><code>_VERSION</code></a></h3>
<p>
A global variable (not a function) that
holds a string containing the running Lua version.
The current value of this variable is "<code>Lua 5.4</code>".
<p>
<hr><h3><a name="pdf-warn"><code>warn (msg1, ···)</code></a></h3>
<p>
Emits a warning with a message composed by the concatenation
of all its arguments (which should be strings).
<p>
By convention,
a one-piece message starting with '<code>@</code>'
is intended to be a <em>control message</em>,
which is a message to the warning system itself.
In particular, the standard warning function in Lua
recognizes the control messages "<code>@off</code>",
to stop the emission of warnings,
and "<code>@on</code>", to (re)start the emission;
it ignores unknown control messages.
<p>
<hr><h3><a name="pdf-xpcall"><code>xpcall (f, msgh [, arg1, ···])</code></a></h3>
<p>
This function is similar to <a href="#pdf-pcall"><code>pcall</code></a>,
except that it sets a new message handler <code>msgh</code>.
<h2>6.2 – <a name="6.2">Coroutine Manipulation</a></h2>
<p>
This library comprises the operations to manipulate coroutines,
which come inside the table <a name="pdf-coroutine"><code>coroutine</code></a>.
See <a href="#2.6">§2.6</a> for a general description of coroutines.
<p>
<hr><h3><a name="pdf-coroutine.close"><code>coroutine.close (co)</code></a></h3>
<p>
Closes coroutine <code>co</code>,
that is,
closes all its pending to-be-closed variables
and puts the coroutine in a dead state.
The given coroutine must be dead or suspended.
In case of error
(either the original error that stopped the coroutine or
errors in closing methods),
returns <b>false</b> plus the error object;
otherwise returns <b>true</b>.
<p>
<hr><h3><a name="pdf-coroutine.create"><code>coroutine.create (f)</code></a></h3>
<p>
Creates a new coroutine, with body <code>f</code>.
<code>f</code> must be a function.
Returns this new coroutine,
an object with type <code>"thread"</code>.
<p>
<hr><h3><a name="pdf-coroutine.isyieldable"><code>coroutine.isyieldable ([co])</code></a></h3>
<p>
Returns true when the coroutine <code>co</code> can yield.
The default for <code>co</code> is the running coroutine.
<p>
A coroutine is yieldable if it is not the main thread and
it is not inside a non-yieldable C function.
<p>
<hr><h3><a name="pdf-coroutine.resume"><code>coroutine.resume (co [, val1, ···])</code></a></h3>
<p>
Starts or continues the execution of coroutine <code>co</code>.
The first time you resume a coroutine,
it starts running its body.
The values <code>val1</code>, ... are passed
as the arguments to the body function.
If the coroutine has yielded,
<code>resume</code> restarts it;
the values <code>val1</code>, ... are passed
as the results from the yield.
<p>
If the coroutine runs without any errors,
<code>resume</code> returns <b>true</b> plus any values passed to <code>yield</code>
(when the coroutine yields) or any values returned by the body function
(when the coroutine terminates).
If there is any error,
<code>resume</code> returns <b>false</b> plus the error message.
<p>
<hr><h3><a name="pdf-coroutine.running"><code>coroutine.running ()</code></a></h3>
<p>
Returns the running coroutine plus a boolean,
true when the running coroutine is the main one.
<p>
<hr><h3><a name="pdf-coroutine.status"><code>coroutine.status (co)</code></a></h3>
<p>
Returns the status of the coroutine <code>co</code>, as a string:
<code>"running"</code>,
if the coroutine is running
(that is, it is the one that called <code>status</code>);
<code>"suspended"</code>, if the coroutine is suspended in a call to <code>yield</code>,
or if it has not started running yet;
<code>"normal"</code> if the coroutine is active but not running
(that is, it has resumed another coroutine);
and <code>"dead"</code> if the coroutine has finished its body function,
or if it has stopped with an error.
<p>
<hr><h3><a name="pdf-coroutine.wrap"><code>coroutine.wrap (f)</code></a></h3>
<p>
Creates a new coroutine, with body <code>f</code>;
<code>f</code> must be a function.
Returns a function that resumes the coroutine each time it is called.
Any arguments passed to this function behave as the
extra arguments to <code>resume</code>.
The function returns the same values returned by <code>resume</code>,
except the first boolean.
In case of error,
the function closes the coroutine and propagates the error.
<p>
<hr><h3><a name="pdf-coroutine.yield"><code>coroutine.yield (···)</code></a></h3>
<p>
Suspends the execution of the calling coroutine.
Any arguments to <code>yield</code> are passed as extra results to <code>resume</code>.
<h2>6.3 – <a name="6.3">Modules</a></h2>
<p>
The package library provides basic
facilities for loading modules in Lua.
It exports one function directly in the global environment:
<a href="#pdf-require"><code>require</code></a>.
Everything else is exported in the table <a name="pdf-package"><code>package</code></a>.
<p>
<hr><h3><a name="pdf-require"><code>require (modname)</code></a></h3>
<p>
Loads the given module.
The function starts by looking into the <a href="#pdf-package.loaded"><code>package.loaded</code></a> table
to determine whether <code>modname</code> is already loaded.
If it is, then <code>require</code> returns the value stored
at <code>package.loaded[modname]</code>.
(The absence of a second result in this case
signals that this call did not have to load the module.)
Otherwise, it tries to find a <em>loader</em> for the module.
<p>
To find a loader,
<code>require</code> is guided by the table <a href="#pdf-package.searchers"><code>package.searchers</code></a>.
Each item in this table is a search function,
that searches for the module in a particular way.
By changing this table,
we can change how <code>require</code> looks for a module.
The following explanation is based on the default configuration
for <a href="#pdf-package.searchers"><code>package.searchers</code></a>.
<p>
First <code>require</code> queries <code>package.preload[modname]</code>.
If it has a value,
this value (which must be a function) is the loader.
Otherwise <code>require</code> searches for a Lua loader using the
path stored in <a href="#pdf-package.path"><code>package.path</code></a>.
If that also fails, it searches for a C loader using the
path stored in <a href="#pdf-package.cpath"><code>package.cpath</code></a>.
If that also fails,
it tries an <em>all-in-one</em> loader (see <a href="#pdf-package.searchers"><code>package.searchers</code></a>).
<p>
Once a loader is found,
<code>require</code> calls the loader with two arguments:
<code>modname</code> and an extra value,
a <em>loader data</em>,
also returned by the searcher.
The loader data can be any value useful to the module;
for the default searchers,
it indicates where the loader was found.
(For instance, if the loader came from a file,
this extra value is the file path.)
If the loader returns any non-nil value,
<code>require</code> assigns the returned value to <code>package.loaded[modname]</code>.
If the loader does not return a non-nil value and
has not assigned any value to <code>package.loaded[modname]</code>,
then <code>require</code> assigns <b>true</b> to this entry.
In any case, <code>require</code> returns the
final value of <code>package.loaded[modname]</code>.
Besides that value, <code>require</code> also returns as a second result
the loader data returned by the searcher,
which indicates how <code>require</code> found the module.
<p>
If there is any error loading or running the module,
or if it cannot find any loader for the module,
then <code>require</code> raises an error.
<p>
<hr><h3><a name="pdf-package.config"><code>package.config</code></a></h3>
<p>
A string describing some compile-time configurations for packages.
This string is a sequence of lines:
<ul>
<li>The first line is the directory separator string.
Default is '<code>\</code>' for Windows and '<code>/</code>' for all other systems.</li>
<li>The second line is the character that separates templates in a path.
Default is '<code>;</code>'.</li>
<li>The third line is the string that marks the
substitution points in a template.
Default is '<code>?</code>'.</li>
<li>The fourth line is a string that, in a path in Windows,
is replaced by the executable's directory.
Default is '<code>!</code>'.</li>
<li>The fifth line is a mark to ignore all text after it
when building the <code>luaopen_</code> function name.
Default is '<code>-</code>'.</li>
</ul>
<p>
<hr><h3><a name="pdf-package.cpath"><code>package.cpath</code></a></h3>
<p>
A string with the path used by <a href="#pdf-require"><code>require</code></a>
to search for a C loader.
<p>
Lua initializes the C path <a href="#pdf-package.cpath"><code>package.cpath</code></a> in the same way
it initializes the Lua path <a href="#pdf-package.path"><code>package.path</code></a>,
using the environment variable <a name="pdf-LUA_CPATH_5_4"><code>LUA_CPATH_5_4</code></a>,
or the environment variable <a name="pdf-LUA_CPATH"><code>LUA_CPATH</code></a>,
or a default path defined in <code>luaconf.h</code>.
<p>
<hr><h3><a name="pdf-package.loaded"><code>package.loaded</code></a></h3>
<p>
A table used by <a href="#pdf-require"><code>require</code></a> to control which
modules are already loaded.
When you require a module <code>modname</code> and
<code>package.loaded[modname]</code> is not false,
<a href="#pdf-require"><code>require</code></a> simply returns the value stored there.
<p>
This variable is only a reference to the real table;
assignments to this variable do not change the
table used by <a href="#pdf-require"><code>require</code></a>.
<p>
<hr><h3><a name="pdf-package.loadlib"><code>package.loadlib (libname, funcname)</code></a></h3>
<p>
Dynamically links the host program with the C library <code>libname</code>.
<p>
If <code>funcname</code> is "<code>*</code>",
then it only links with the library,
making the symbols exported by the library
available to other dynamically linked libraries.
Otherwise,
it looks for a function <code>funcname</code> inside the library
and returns this function as a C function.
So, <code>funcname</code> must follow the <a href="#lua_CFunction"><code>lua_CFunction</code></a> prototype
(see <a href="#lua_CFunction"><code>lua_CFunction</code></a>).
<p>
This is a low-level function.
It completely bypasses the package and module system.
Unlike <a href="#pdf-require"><code>require</code></a>,
it does not perform any path searching and
does not automatically adds extensions.
<code>libname</code> must be the complete file name of the C library,
including if necessary a path and an extension.
<code>funcname</code> must be the exact name exported by the C library
(which may depend on the C compiler and linker used).
<p>
This function is not supported by Standard C.
As such, it is only available on some platforms
(Windows, Linux, Mac OS X, Solaris, BSD,
plus other Unix systems that support the <code>dlfcn</code> standard).
<p>
This function is inherently insecure,
as it allows Lua to call any function in any readable dynamic
library in the system.
(Lua calls any function assuming the function
has a proper prototype and respects a proper protocol
(see <a href="#lua_CFunction"><code>lua_CFunction</code></a>).
Therefore,
calling an arbitrary function in an arbitrary dynamic library
more often than not results in an access violation.)
<p>
<hr><h3><a name="pdf-package.path"><code>package.path</code></a></h3>
<p>
A string with the path used by <a href="#pdf-require"><code>require</code></a>
to search for a Lua loader.
<p>
At start-up, Lua initializes this variable with
the value of the environment variable <a name="pdf-LUA_PATH_5_4"><code>LUA_PATH_5_4</code></a> or
the environment variable <a name="pdf-LUA_PATH"><code>LUA_PATH</code></a> or
with a default path defined in <code>luaconf.h</code>,
if those environment variables are not defined.
A "<code>;;</code>" in the value of the environment variable
is replaced by the default path.
<p>
<hr><h3><a name="pdf-package.preload"><code>package.preload</code></a></h3>
<p>
A table to store loaders for specific modules
(see <a href="#pdf-require"><code>require</code></a>).
<p>
This variable is only a reference to the real table;
assignments to this variable do not change the
table used by <a href="#pdf-require"><code>require</code></a>.
<p>
<hr><h3><a name="pdf-package.searchers"><code>package.searchers</code></a></h3>
<p>
A table used by <a href="#pdf-require"><code>require</code></a> to control how to find modules.
<p>
Each entry in this table is a <em>searcher function</em>.
When looking for a module,
<a href="#pdf-require"><code>require</code></a> calls each of these searchers in ascending order,
with the module name (the argument given to <a href="#pdf-require"><code>require</code></a>) as its
sole argument.
If the searcher finds the module,
it returns another function, the module <em>loader</em>,
plus an extra value, a <em>loader data</em>,
that will be passed to that loader and
returned as a second result by <a href="#pdf-require"><code>require</code></a>.
If it cannot find the module,
it returns a string explaining why
(or <b>nil</b> if it has nothing to say).
<p>
Lua initializes this table with four searcher functions.
<p>
The first searcher simply looks for a loader in the
<a href="#pdf-package.preload"><code>package.preload</code></a> table.
<p>
The second searcher looks for a loader as a Lua library,
using the path stored at <a href="#pdf-package.path"><code>package.path</code></a>.
The search is done as described in function <a href="#pdf-package.searchpath"><code>package.searchpath</code></a>.
<p>
The third searcher looks for a loader as a C library,
using the path given by the variable <a href="#pdf-package.cpath"><code>package.cpath</code></a>.
Again,
the search is done as described in function <a href="#pdf-package.searchpath"><code>package.searchpath</code></a>.
For instance,
if the C path is the string
<pre>
"./?.so;./?.dll;/usr/local/?/init.so"
</pre><p>
the searcher for module <code>foo</code>
will try to open the files <code>./foo.so</code>, <code>./foo.dll</code>,
and <code>/usr/local/foo/init.so</code>, in that order.
Once it finds a C library,
this searcher first uses a dynamic link facility to link the
application with the library.
Then it tries to find a C function inside the library to
be used as the loader.
The name of this C function is the string "<code>luaopen_</code>"
concatenated with a copy of the module name where each dot
is replaced by an underscore.
Moreover, if the module name has a hyphen,
its suffix after (and including) the first hyphen is removed.
For instance, if the module name is <code>a.b.c-v2.1</code>,
the function name will be <code>luaopen_a_b_c</code>.
<p>
The fourth searcher tries an <em>all-in-one loader</em>.
It searches the C path for a library for
the root name of the given module.
For instance, when requiring <code>a.b.c</code>,
it will search for a C library for <code>a</code>.
If found, it looks into it for an open function for
the submodule;
in our example, that would be <code>luaopen_a_b_c</code>.
With this facility, a package can pack several C submodules
into one single library,
with each submodule keeping its original open function.
<p>
All searchers except the first one (preload) return as the extra value
the file path where the module was found,
as returned by <a href="#pdf-package.searchpath"><code>package.searchpath</code></a>.
The first searcher always returns the string "<code>:preload:</code>".
<p>
Searchers should raise no errors and have no side effects in Lua.
(They may have side effects in C,
for instance by linking the application with a library.)
<p>
<hr><h3><a name="pdf-package.searchpath"><code>package.searchpath (name, path [, sep [, rep]])</code></a></h3>
<p>
Searches for the given <code>name</code> in the given <code>path</code>.
<p>
A path is a string containing a sequence of
<em>templates</em> separated by semicolons.
For each template,
the function replaces each interrogation mark (if any)
in the template with a copy of <code>name</code>
wherein all occurrences of <code>sep</code>
(a dot, by default)
were replaced by <code>rep</code>
(the system's directory separator, by default),
and then tries to open the resulting file name.
<p>
For instance, if the path is the string
<pre>
"./?.lua;./?.lc;/usr/local/?/init.lua"
</pre><p>
the search for the name <code>foo.a</code>
will try to open the files
<code>./foo/a.lua</code>, <code>./foo/a.lc</code>, and
<code>/usr/local/foo/a/init.lua</code>, in that order.
<p>
Returns the resulting name of the first file that it can
open in read mode (after closing the file),
or <b>fail</b> plus an error message if none succeeds.
(This error message lists all file names it tried to open.)
<h2>6.4 – <a name="6.4">String Manipulation</a></h2>
<p>
This library provides generic functions for string manipulation,
such as finding and extracting substrings, and pattern matching.
When indexing a string in Lua, the first character is at position 1
(not at 0, as in C).
Indices are allowed to be negative and are interpreted as indexing backwards,
from the end of the string.
Thus, the last character is at position -1, and so on.
<p>
The string library provides all its functions inside the table
<a name="pdf-string"><code>string</code></a>.
It also sets a metatable for strings
where the <code>__index</code> field points to the <code>string</code> table.
Therefore, you can use the string functions in object-oriented style.
For instance, <code>string.byte(s,i)</code>
can be written as <code>s:byte(i)</code>.
<p>
The string library assumes one-byte character encodings.
<p>
<hr><h3><a name="pdf-string.byte"><code>string.byte (s [, i [, j]])</code></a></h3>
Returns the internal numeric codes of the characters <code>s[i]</code>,
<code>s[i+1]</code>, ..., <code>s[j]</code>.
The default value for <code>i</code> is 1;
the default value for <code>j</code> is <code>i</code>.
These indices are corrected
following the same rules of function <a href="#pdf-string.sub"><code>string.sub</code></a>.
<p>
Numeric codes are not necessarily portable across platforms.
<p>
<hr><h3><a name="pdf-string.char"><code>string.char (···)</code></a></h3>
Receives zero or more integers.
Returns a string with length equal to the number of arguments,
in which each character has the internal numeric code equal
to its corresponding argument.
<p>
Numeric codes are not necessarily portable across platforms.
<p>
<hr><h3><a name="pdf-string.dump"><code>string.dump (function [, strip])</code></a></h3>
<p>
Returns a string containing a binary representation
(a <em>binary chunk</em>)
of the given function,
so that a later <a href="#pdf-load"><code>load</code></a> on this string returns
a copy of the function (but with new upvalues).
If <code>strip</code> is a true value,
the binary representation may not include all debug information
about the function,
to save space.
<p>
Functions with upvalues have only their number of upvalues saved.
When (re)loaded,
those upvalues receive fresh instances.
(See the <a href="#pdf-load"><code>load</code></a> function for details about
how these upvalues are initialized.
You can use the debug library to serialize
and reload the upvalues of a function
in a way adequate to your needs.)
<p>
<hr><h3><a name="pdf-string.find"><code>string.find (s, pattern [, init [, plain]])</code></a></h3>
<p>
Looks for the first match of
<code>pattern</code> (see <a href="#6.4.1">§6.4.1</a>) in the string <code>s</code>.
If it finds a match, then <code>find</code> returns the indices of <code>s</code>
where this occurrence starts and ends;
otherwise, it returns <b>fail</b>.
A third, optional numeric argument <code>init</code> specifies
where to start the search;
its default value is 1 and can be negative.
A value of <b>true</b> as a fourth, optional argument <code>plain</code>
turns off the pattern matching facilities,
so the function does a plain "find substring" operation,
with no characters in <code>pattern</code> being considered magic.
<p>
If the pattern has captures,
then in a successful match
the captured values are also returned,
after the two indices.
<p>
<hr><h3><a name="pdf-string.format"><code>string.format (formatstring, ···)</code></a></h3>
<p>
Returns a formatted version of its variable number of arguments
following the description given in its first argument,
which must be a string.
The format string follows the same rules as the ISO C function <code>sprintf</code>.
The only differences are that the conversion specifiers and modifiers
<code>*</code>, <code>h</code>, <code>L</code>, <code>l</code>, and <code>n</code> are not supported
and that there is an extra specifier, <code>q</code>.
<p>
The specifier <code>q</code> formats booleans, nil, numbers, and strings
in a way that the result is a valid constant in Lua source code.
Booleans and nil are written in the obvious way
(<code>true</code>, <code>false</code>, <code>nil</code>).
Floats are written in hexadecimal,
to preserve full precision.
A string is written between double quotes,
using escape sequences when necessary to ensure that
it can safely be read back by the Lua interpreter.
For instance, the call
<pre>
string.format('%q', 'a string with "quotes" and \n new line')
</pre><p>
may produce the string:
<pre>
"a string with \"quotes\" and \
new line"
</pre><p>
This specifier does not support modifiers (flags, width, length).
<p>
The conversion specifiers
<code>A</code>, <code>a</code>, <code>E</code>, <code>e</code>, <code>f</code>,
<code>G</code>, and <code>g</code> all expect a number as argument.
The specifiers <code>c</code>, <code>d</code>,
<code>i</code>, <code>o</code>, <code>u</code>, <code>X</code>, and <code>x</code>
expect an integer.
When Lua is compiled with a C89 compiler,
the specifiers <code>A</code> and <code>a</code> (hexadecimal floats)
do not support modifiers.
<p>
The specifier <code>s</code> expects a string;
if its argument is not a string,
it is converted to one following the same rules of <a href="#pdf-tostring"><code>tostring</code></a>.
If the specifier has any modifier,
the corresponding string argument should not contain embedded zeros.
<p>
The specifier <code>p</code> formats the pointer
returned by <a href="#lua_topointer"><code>lua_topointer</code></a>.
That gives a unique string identifier for tables, userdata,
threads, strings, and functions.
For other values (numbers, nil, booleans),
this specifier results in a string representing
the pointer <code>NULL</code>.
<p>
<hr><h3><a name="pdf-string.gmatch"><code>string.gmatch (s, pattern [, init])</code></a></h3>
Returns an iterator function that,
each time it is called,
returns the next captures from <code>pattern</code> (see <a href="#6.4.1">§6.4.1</a>)
over the string <code>s</code>.
If <code>pattern</code> specifies no captures,
then the whole match is produced in each call.
A third, optional numeric argument <code>init</code> specifies
where to start the search;
its default value is 1 and can be negative.
<p>
As an example, the following loop
will iterate over all the words from string <code>s</code>,
printing one per line:
<pre>
s = "hello world from Lua"
for w in string.gmatch(s, "%a+") do
print(w)
end
</pre><p>
The next example collects all pairs <code>key=value</code> from the
given string into a table:
<pre>
t = {}
s = "from=world, to=Lua"
for k, v in string.gmatch(s, "(%w+)=(%w+)") do
t[k] = v
end
</pre>
<p>
For this function, a caret '<code>^</code>' at the start of a pattern does not
work as an anchor, as this would prevent the iteration.
<p>
<hr><h3><a name="pdf-string.gsub"><code>string.gsub (s, pattern, repl [, n])</code></a></h3>
Returns a copy of <code>s</code>
in which all (or the first <code>n</code>, if given)
occurrences of the <code>pattern</code> (see <a href="#6.4.1">§6.4.1</a>) have been
replaced by a replacement string specified by <code>repl</code>,
which can be a string, a table, or a function.
<code>gsub</code> also returns, as its second value,
the total number of matches that occurred.
The name <code>gsub</code> comes from <em>Global SUBstitution</em>.
<p>
If <code>repl</code> is a string, then its value is used for replacement.
The character <code>%</code> works as an escape character:
any sequence in <code>repl</code> of the form <code>%<em>d</em></code>,
with <em>d</em> between 1 and 9,
stands for the value of the <em>d</em>-th captured substring;
the sequence <code>%0</code> stands for the whole match;
the sequence <code>%%</code> stands for a single <code>%</code>.
<p>
If <code>repl</code> is a table, then the table is queried for every match,
using the first capture as the key.
<p>
If <code>repl</code> is a function, then this function is called every time a
match occurs, with all captured substrings passed as arguments,
in order.
<p>
In any case,
if the pattern specifies no captures,
then it behaves as if the whole pattern was inside a capture.
<p>
If the value returned by the table query or by the function call
is a string or a number,
then it is used as the replacement string;
otherwise, if it is <b>false</b> or <b>nil</b>,
then there is no replacement
(that is, the original match is kept in the string).
<p>
Here are some examples:
<pre>
x = string.gsub("hello world", "(%w+)", "%1 %1")
--> x="hello hello world world"
x = string.gsub("hello world", "%w+", "%0 %0", 1)
--> x="hello hello world"
x = string.gsub("hello world from Lua", "(%w+)%s*(%w+)", "%2 %1")
--> x="world hello Lua from"
x = string.gsub("home = $HOME, user = $USER", "%$(%w+)", os.getenv)
--> x="home = /home/roberto, user = roberto"
x = string.gsub("4+5 = $return 4+5$", "%$(.-)%$", function (s)
return load(s)()
end)
--> x="4+5 = 9"
local t = {name="lua", version="5.4"}
x = string.gsub("$name-$version.tar.gz", "%$(%w+)", t)
--> x="lua-5.4.tar.gz"
</pre>
<p>
<hr><h3><a name="pdf-string.len"><code>string.len (s)</code></a></h3>
<p>
Receives a string and returns its length.
The empty string <code>""</code> has length 0.
Embedded zeros are counted,
so <code>"a\000bc\000"</code> has length 5.
<p>
<hr><h3><a name="pdf-string.lower"><code>string.lower (s)</code></a></h3>
<p>
Receives a string and returns a copy of this string with all
uppercase letters changed to lowercase.
All other characters are left unchanged.
The definition of what an uppercase letter is depends on the current locale.
<p>
<hr><h3><a name="pdf-string.match"><code>string.match (s, pattern [, init])</code></a></h3>
<p>
Looks for the first <em>match</em> of
the <code>pattern</code> (see <a href="#6.4.1">§6.4.1</a>) in the string <code>s</code>.
If it finds one, then <code>match</code> returns
the captures from the pattern;
otherwise it returns <b>fail</b>.
If <code>pattern</code> specifies no captures,
then the whole match is returned.
A third, optional numeric argument <code>init</code> specifies
where to start the search;
its default value is 1 and can be negative.
<p>
<hr><h3><a name="pdf-string.pack"><code>string.pack (fmt, v1, v2, ···)</code></a></h3>
<p>
Returns a binary string containing the values <code>v1</code>, <code>v2</code>, etc.
serialized in binary form (packed)
according to the format string <code>fmt</code> (see <a href="#6.4.2">§6.4.2</a>).
<p>
<hr><h3><a name="pdf-string.packsize"><code>string.packsize (fmt)</code></a></h3>
<p>
Returns the size of a string resulting from <a href="#pdf-string.pack"><code>string.pack</code></a>
with the given format.
The format string cannot have the variable-length options
'<code>s</code>' or '<code>z</code>' (see <a href="#6.4.2">§6.4.2</a>).
<p>
<hr><h3><a name="pdf-string.rep"><code>string.rep (s, n [, sep])</code></a></h3>
<p>
Returns a string that is the concatenation of <code>n</code> copies of
the string <code>s</code> separated by the string <code>sep</code>.
The default value for <code>sep</code> is the empty string
(that is, no separator).
Returns the empty string if <code>n</code> is not positive.
<p>
(Note that it is very easy to exhaust the memory of your machine
with a single call to this function.)
<p>
<hr><h3><a name="pdf-string.reverse"><code>string.reverse (s)</code></a></h3>
<p>
Returns a string that is the string <code>s</code> reversed.
<p>
<hr><h3><a name="pdf-string.sub"><code>string.sub (s, i [, j])</code></a></h3>
<p>
Returns the substring of <code>s</code> that
starts at <code>i</code> and continues until <code>j</code>;
<code>i</code> and <code>j</code> can be negative.
If <code>j</code> is absent, then it is assumed to be equal to -1
(which is the same as the string length).
In particular,
the call <code>string.sub(s,1,j)</code> returns a prefix of <code>s</code>
with length <code>j</code>,
and <code>string.sub(s, -i)</code> (for a positive <code>i</code>)
returns a suffix of <code>s</code>
with length <code>i</code>.
<p>
If, after the translation of negative indices,
<code>i</code> is less than 1,
it is corrected to 1.
If <code>j</code> is greater than the string length,
it is corrected to that length.
If, after these corrections,
<code>i</code> is greater than <code>j</code>,
the function returns the empty string.
<p>
<hr><h3><a name="pdf-string.unpack"><code>string.unpack (fmt, s [, pos])</code></a></h3>
<p>
Returns the values packed in string <code>s</code> (see <a href="#pdf-string.pack"><code>string.pack</code></a>)
according to the format string <code>fmt</code> (see <a href="#6.4.2">§6.4.2</a>).
An optional <code>pos</code> marks where
to start reading in <code>s</code> (default is 1).
After the read values,
this function also returns the index of the first unread byte in <code>s</code>.
<p>
<hr><h3><a name="pdf-string.upper"><code>string.upper (s)</code></a></h3>
<p>
Receives a string and returns a copy of this string with all
lowercase letters changed to uppercase.
All other characters are left unchanged.
The definition of what a lowercase letter is depends on the current locale.
<h3>6.4.1 – <a name="6.4.1">Patterns</a></h3>
<p>
Patterns in Lua are described by regular strings,
which are interpreted as patterns by the pattern-matching functions
<a href="#pdf-string.find"><code>string.find</code></a>,
<a href="#pdf-string.gmatch"><code>string.gmatch</code></a>,
<a href="#pdf-string.gsub"><code>string.gsub</code></a>,
and <a href="#pdf-string.match"><code>string.match</code></a>.
This section describes the syntax and the meaning
(that is, what they match) of these strings.
<h4>Character Class:</h4><p>
A <em>character class</em> is used to represent a set of characters.
The following combinations are allowed in describing a character class:
<ul>
<li><b><em>x</em>: </b>
(where <em>x</em> is not one of the <em>magic characters</em>
<code>^$()%.[]*+-?</code>)
represents the character <em>x</em> itself.
</li>
<li><b><code>.</code>: </b> (a dot) represents all characters.</li>
<li><b><code>%a</code>: </b> represents all letters.</li>
<li><b><code>%c</code>: </b> represents all control characters.</li>
<li><b><code>%d</code>: </b> represents all digits.</li>
<li><b><code>%g</code>: </b> represents all printable characters except space.</li>
<li><b><code>%l</code>: </b> represents all lowercase letters.</li>
<li><b><code>%p</code>: </b> represents all punctuation characters.</li>
<li><b><code>%s</code>: </b> represents all space characters.</li>
<li><b><code>%u</code>: </b> represents all uppercase letters.</li>
<li><b><code>%w</code>: </b> represents all alphanumeric characters.</li>
<li><b><code>%x</code>: </b> represents all hexadecimal digits.</li>
<li><b><code>%<em>x</em></code>: </b> (where <em>x</em> is any non-alphanumeric character)
represents the character <em>x</em>.
This is the standard way to escape the magic characters.
Any non-alphanumeric character
(including all punctuation characters, even the non-magical)
can be preceded by a '<code>%</code>' to represent itself in a pattern.
</li>
<li><b><code>[<em>set</em>]</code>: </b>
represents the class which is the union of all
characters in <em>set</em>.
A range of characters can be specified by
separating the end characters of the range,
in ascending order, with a '<code>-</code>'.
All classes <code>%</code><em>x</em> described above can also be used as
components in <em>set</em>.
All other characters in <em>set</em> represent themselves.
For example, <code>[%w_]</code> (or <code>[_%w]</code>)
represents all alphanumeric characters plus the underscore,
<code>[0-7]</code> represents the octal digits,
and <code>[0-7%l%-]</code> represents the octal digits plus
the lowercase letters plus the '<code>-</code>' character.
<p>
You can put a closing square bracket in a set
by positioning it as the first character in the set.
You can put a hyphen in a set
by positioning it as the first or the last character in the set.
(You can also use an escape for both cases.)
<p>
The interaction between ranges and classes is not defined.
Therefore, patterns like <code>[%a-z]</code> or <code>[a-%%]</code>
have no meaning.
</li>
<li><b><code>[^<em>set</em>]</code>: </b>
represents the complement of <em>set</em>,
where <em>set</em> is interpreted as above.
</li>
</ul><p>
For all classes represented by single letters (<code>%a</code>, <code>%c</code>, etc.),
the corresponding uppercase letter represents the complement of the class.
For instance, <code>%S</code> represents all non-space characters.
<p>
The definitions of letter, space, and other character groups
depend on the current locale.
In particular, the class <code>[a-z]</code> may not be equivalent to <code>%l</code>.
<h4>Pattern Item:</h4><p>
A <em>pattern item</em> can be
<ul>
<li>
a single character class,
which matches any single character in the class;
</li>
<li>
a single character class followed by '<code>*</code>',
which matches sequences of zero or more characters in the class.
These repetition items will always match the longest possible sequence;
</li>
<li>
a single character class followed by '<code>+</code>',
which matches sequences of one or more characters in the class.
These repetition items will always match the longest possible sequence;
</li>
<li>
a single character class followed by '<code>-</code>',
which also matches sequences of zero or more characters in the class.
Unlike '<code>*</code>',
these repetition items will always match the shortest possible sequence;
</li>
<li>
a single character class followed by '<code>?</code>',
which matches zero or one occurrence of a character in the class.
It always matches one occurrence if possible;
</li>
<li>
<code>%<em>n</em></code>, for <em>n</em> between 1 and 9;
such item matches a substring equal to the <em>n</em>-th captured string
(see below);
</li>
<li>
<code>%b<em>xy</em></code>, where <em>x</em> and <em>y</em> are two distinct characters;
such item matches strings that start with <em>x</em>, end with <em>y</em>,
and where the <em>x</em> and <em>y</em> are <em>balanced</em>.
This means that, if one reads the string from left to right,
counting <em>+1</em> for an <em>x</em> and <em>-1</em> for a <em>y</em>,
the ending <em>y</em> is the first <em>y</em> where the count reaches 0.
For instance, the item <code>%b()</code> matches expressions with
balanced parentheses.
</li>
<li>
<code>%f[<em>set</em>]</code>, a <em>frontier pattern</em>;
such item matches an empty string at any position such that
the next character belongs to <em>set</em>
and the previous character does not belong to <em>set</em>.
The set <em>set</em> is interpreted as previously described.
The beginning and the end of the subject are handled as if
they were the character '<code>\0</code>'.
</li>
</ul>
<h4>Pattern:</h4><p>
A <em>pattern</em> is a sequence of pattern items.
A caret '<code>^</code>' at the beginning of a pattern anchors the match at the
beginning of the subject string.
A '<code>$</code>' at the end of a pattern anchors the match at the
end of the subject string.
At other positions,
'<code>^</code>' and '<code>$</code>' have no special meaning and represent themselves.
<h4>Captures:</h4><p>
A pattern can contain sub-patterns enclosed in parentheses;
they describe <em>captures</em>.
When a match succeeds, the substrings of the subject string
that match captures are stored (<em>captured</em>) for future use.
Captures are numbered according to their left parentheses.
For instance, in the pattern <code>"(a*(.)%w(%s*))"</code>,
the part of the string matching <code>"a*(.)%w(%s*)"</code> is
stored as the first capture, and therefore has number 1;
the character matching "<code>.</code>" is captured with number 2,
and the part matching "<code>%s*</code>" has number 3.
<p>
As a special case, the capture <code>()</code> captures
the current string position (a number).
For instance, if we apply the pattern <code>"()aa()"</code> on the
string <code>"flaaap"</code>, there will be two captures: 3 and 5.
<h4>Multiple matches:</h4><p>
The function <a href="#pdf-string.gsub"><code>string.gsub</code></a> and the iterator <a href="#pdf-string.gmatch"><code>string.gmatch</code></a>
match multiple occurrences of the given pattern in the subject.
For these functions,
a new match is considered valid only
if it ends at least one byte after the end of the previous match.
In other words, the pattern machine never accepts the
empty string as a match immediately after another match.
As an example,
consider the results of the following code:
<pre>
> string.gsub("abc", "()a*()", print);
--> 1 2
--> 3 3
--> 4 4
</pre><p>
The second and third results come from Lua matching an empty
string after '<code>b</code>' and another one after '<code>c</code>'.
Lua does not match an empty string after '<code>a</code>',
because it would end at the same position of the previous match.
<h3>6.4.2 – <a name="6.4.2">Format Strings for Pack and Unpack</a></h3>
<p>
The first argument to <a href="#pdf-string.pack"><code>string.pack</code></a>,
<a href="#pdf-string.packsize"><code>string.packsize</code></a>, and <a href="#pdf-string.unpack"><code>string.unpack</code></a>
is a format string,
which describes the layout of the structure being created or read.
<p>
A format string is a sequence of conversion options.
The conversion options are as follows:
<ul>
<li><b><code><</code>: </b>sets little endian</li>
<li><b><code>></code>: </b>sets big endian</li>
<li><b><code>=</code>: </b>sets native endian</li>
<li><b><code>![<em>n</em>]</code>: </b>sets maximum alignment to <code>n</code>
(default is native alignment)</li>
<li><b><code>b</code>: </b>a signed byte (<code>char</code>)</li>
<li><b><code>B</code>: </b>an unsigned byte (<code>char</code>)</li>
<li><b><code>h</code>: </b>a signed <code>short</code> (native size)</li>
<li><b><code>H</code>: </b>an unsigned <code>short</code> (native size)</li>
<li><b><code>l</code>: </b>a signed <code>long</code> (native size)</li>
<li><b><code>L</code>: </b>an unsigned <code>long</code> (native size)</li>
<li><b><code>j</code>: </b>a <code>lua_Integer</code></li>
<li><b><code>J</code>: </b>a <code>lua_Unsigned</code></li>
<li><b><code>T</code>: </b>a <code>size_t</code> (native size)</li>
<li><b><code>i[<em>n</em>]</code>: </b>a signed <code>int</code> with <code>n</code> bytes
(default is native size)</li>
<li><b><code>I[<em>n</em>]</code>: </b>an unsigned <code>int</code> with <code>n</code> bytes
(default is native size)</li>
<li><b><code>f</code>: </b>a <code>float</code> (native size)</li>
<li><b><code>d</code>: </b>a <code>double</code> (native size)</li>
<li><b><code>n</code>: </b>a <code>lua_Number</code></li>
<li><b><code>c<em>n</em></code>: </b>a fixed-sized string with <code>n</code> bytes</li>
<li><b><code>z</code>: </b>a zero-terminated string</li>
<li><b><code>s[<em>n</em>]</code>: </b>a string preceded by its length
coded as an unsigned integer with <code>n</code> bytes
(default is a <code>size_t</code>)</li>
<li><b><code>x</code>: </b>one byte of padding</li>
<li><b><code>X<em>op</em></code>: </b>an empty item that aligns
according to option <code>op</code>
(which is otherwise ignored)</li>
<li><b>'<code> </code>': </b>(space) ignored</li>
</ul><p>
(A "<code>[<em>n</em>]</code>" means an optional integral numeral.)
Except for padding, spaces, and configurations
(options "<code>xX <=>!</code>"),
each option corresponds to an argument in <a href="#pdf-string.pack"><code>string.pack</code></a>
or a result in <a href="#pdf-string.unpack"><code>string.unpack</code></a>.
<p>
For options "<code>!<em>n</em></code>", "<code>s<em>n</em></code>", "<code>i<em>n</em></code>", and "<code>I<em>n</em></code>",
<code>n</code> can be any integer between 1 and 16.
All integral options check overflows;
<a href="#pdf-string.pack"><code>string.pack</code></a> checks whether the given value fits in the given size;
<a href="#pdf-string.unpack"><code>string.unpack</code></a> checks whether the read value fits in a Lua integer.
For the unsigned options,
Lua integers are treated as unsigned values too.
<p>
Any format string starts as if prefixed by "<code>!1=</code>",
that is,
with maximum alignment of 1 (no alignment)
and native endianness.
<p>
Native endianness assumes that the whole system is
either big or little endian.
The packing functions will not emulate correctly the behavior
of mixed-endian formats.
<p>
Alignment works as follows:
For each option,
the format gets extra padding until the data starts
at an offset that is a multiple of the minimum between the
option size and the maximum alignment;
this minimum must be a power of 2.
Options "<code>c</code>" and "<code>z</code>" are not aligned;
option "<code>s</code>" follows the alignment of its starting integer.
<p>
All padding is filled with zeros by <a href="#pdf-string.pack"><code>string.pack</code></a>
and ignored by <a href="#pdf-string.unpack"><code>string.unpack</code></a>.
<h2>6.5 – <a name="6.5">UTF-8 Support</a></h2>
<p>
This library provides basic support for UTF-8 encoding.
It provides all its functions inside the table <a name="pdf-utf8"><code>utf8</code></a>.
This library does not provide any support for Unicode other
than the handling of the encoding.
Any operation that needs the meaning of a character,
such as character classification, is outside its scope.
<p>
Unless stated otherwise,
all functions that expect a byte position as a parameter
assume that the given position is either the start of a byte sequence
or one plus the length of the subject string.
As in the string library,
negative indices count from the end of the string.
<p>
Functions that create byte sequences
accept all values up to <code>0x7FFFFFFF</code>,
as defined in the original UTF-8 specification;
that implies byte sequences of up to six bytes.
<p>
Functions that interpret byte sequences only accept
valid sequences (well formed and not overlong).
By default, they only accept byte sequences
that result in valid Unicode code points,
rejecting values greater than <code>10FFFF</code> and surrogates.
A boolean argument <code>lax</code>, when available,
lifts these checks,
so that all values up to <code>0x7FFFFFFF</code> are accepted.
(Not well formed and overlong sequences are still rejected.)
<p>
<hr><h3><a name="pdf-utf8.char"><code>utf8.char (···)</code></a></h3>
<p>
Receives zero or more integers,
converts each one to its corresponding UTF-8 byte sequence
and returns a string with the concatenation of all these sequences.
<p>
<hr><h3><a name="pdf-utf8.charpattern"><code>utf8.charpattern</code></a></h3>
<p>
The pattern (a string, not a function) "<code>[\0-\x7F\xC2-\xFD][\x80-\xBF]*</code>"
(see <a href="#6.4.1">§6.4.1</a>),
which matches exactly one UTF-8 byte sequence,
assuming that the subject is a valid UTF-8 string.
<p>
<hr><h3><a name="pdf-utf8.codes"><code>utf8.codes (s [, lax])</code></a></h3>
<p>
Returns values so that the construction
<pre>
for p, c in utf8.codes(s) do <em>body</em> end
</pre><p>
will iterate over all UTF-8 characters in string <code>s</code>,
with <code>p</code> being the position (in bytes) and <code>c</code> the code point
of each character.
It raises an error if it meets any invalid byte sequence.
<p>
<hr><h3><a name="pdf-utf8.codepoint"><code>utf8.codepoint (s [, i [, j [, lax]]])</code></a></h3>
<p>
Returns the code points (as integers) from all characters in <code>s</code>
that start between byte position <code>i</code> and <code>j</code> (both included).
The default for <code>i</code> is 1 and for <code>j</code> is <code>i</code>.
It raises an error if it meets any invalid byte sequence.
<p>
<hr><h3><a name="pdf-utf8.len"><code>utf8.len (s [, i [, j [, lax]]])</code></a></h3>
<p>
Returns the number of UTF-8 characters in string <code>s</code>
that start between positions <code>i</code> and <code>j</code> (both inclusive).
The default for <code>i</code> is 1 and for <code>j</code> is -1.
If it finds any invalid byte sequence,
returns <b>fail</b> plus the position of the first invalid byte.
<p>
<hr><h3><a name="pdf-utf8.offset"><code>utf8.offset (s, n [, i])</code></a></h3>
<p>
Returns the position (in bytes) where the encoding of the
<code>n</code>-th character of <code>s</code>
(counting from position <code>i</code>) starts.
A negative <code>n</code> gets characters before position <code>i</code>.
The default for <code>i</code> is 1 when <code>n</code> is non-negative
and <code>#s + 1</code> otherwise,
so that <code>utf8.offset(s, -n)</code> gets the offset of the
<code>n</code>-th character from the end of the string.
If the specified character is neither in the subject
nor right after its end,
the function returns <b>fail</b>.
<p>
As a special case,
when <code>n</code> is 0 the function returns the start of the encoding
of the character that contains the <code>i</code>-th byte of <code>s</code>.
<p>
This function assumes that <code>s</code> is a valid UTF-8 string.
<h2>6.6 – <a name="6.6">Table Manipulation</a></h2>
<p>
This library provides generic functions for table manipulation.
It provides all its functions inside the table <a name="pdf-table"><code>table</code></a>.
<p>
Remember that, whenever an operation needs the length of a table,
all caveats about the length operator apply (see <a href="#3.4.7">§3.4.7</a>).
All functions ignore non-numeric keys
in the tables given as arguments.
<p>
<hr><h3><a name="pdf-table.concat"><code>table.concat (list [, sep [, i [, j]]])</code></a></h3>
<p>
Given a list where all elements are strings or numbers,
returns the string <code>list[i]..sep..list[i+1] ··· sep..list[j]</code>.
The default value for <code>sep</code> is the empty string,
the default for <code>i</code> is 1,
and the default for <code>j</code> is <code>#list</code>.
If <code>i</code> is greater than <code>j</code>, returns the empty string.
<p>
<hr><h3><a name="pdf-table.insert"><code>table.insert (list, [pos,] value)</code></a></h3>
<p>
Inserts element <code>value</code> at position <code>pos</code> in <code>list</code>,
shifting up the elements
<code>list[pos], list[pos+1], ···, list[#list]</code>.
The default value for <code>pos</code> is <code>#list+1</code>,
so that a call <code>table.insert(t,x)</code> inserts <code>x</code> at the end
of the list <code>t</code>.
<p>
<hr><h3><a name="pdf-table.move"><code>table.move (a1, f, e, t [,a2])</code></a></h3>
<p>
Moves elements from the table <code>a1</code> to the table <code>a2</code>,
performing the equivalent to the following
multiple assignment:
<code>a2[t],··· = a1[f],···,a1[e]</code>.
The default for <code>a2</code> is <code>a1</code>.
The destination range can overlap with the source range.
The number of elements to be moved must fit in a Lua integer.
<p>
Returns the destination table <code>a2</code>.
<p>
<hr><h3><a name="pdf-table.pack"><code>table.pack (···)</code></a></h3>
<p>
Returns a new table with all arguments stored into keys 1, 2, etc.
and with a field "<code>n</code>" with the total number of arguments.
Note that the resulting table may not be a sequence,
if some arguments are <b>nil</b>.
<p>
<hr><h3><a name="pdf-table.remove"><code>table.remove (list [, pos])</code></a></h3>
<p>
Removes from <code>list</code> the element at position <code>pos</code>,
returning the value of the removed element.
When <code>pos</code> is an integer between 1 and <code>#list</code>,
it shifts down the elements
<code>list[pos+1], list[pos+2], ···, list[#list]</code>
and erases element <code>list[#list]</code>;
The index <code>pos</code> can also be 0 when <code>#list</code> is 0,
or <code>#list + 1</code>.
<p>
The default value for <code>pos</code> is <code>#list</code>,
so that a call <code>table.remove(l)</code> removes the last element
of the list <code>l</code>.
<p>
<hr><h3><a name="pdf-table.sort"><code>table.sort (list [, comp])</code></a></h3>
<p>
Sorts the list elements in a given order, <em>in-place</em>,
from <code>list[1]</code> to <code>list[#list]</code>.
If <code>comp</code> is given,
then it must be a function that receives two list elements
and returns true when the first element must come
before the second in the final order,
so that, after the sort,
<code>i <= j</code> implies <code>not comp(list[j],list[i])</code>.
If <code>comp</code> is not given,
then the standard Lua operator <code><</code> is used instead.
<p>
The <code>comp</code> function must define a consistent order;
more formally, the function must define a strict weak order.
(A weak order is similar to a total order,
but it can equate different elements for comparison purposes.)
<p>
The sort algorithm is not stable:
Different elements considered equal by the given order
may have their relative positions changed by the sort.
<p>
<hr><h3><a name="pdf-table.unpack"><code>table.unpack (list [, i [, j]])</code></a></h3>
<p>
Returns the elements from the given list.
This function is equivalent to
<pre>
return list[i], list[i+1], ···, list[j]
</pre><p>
By default, <code>i</code> is 1 and <code>j</code> is <code>#list</code>.
<h2>6.7 – <a name="6.7">Mathematical Functions</a></h2>
<p>
This library provides basic mathematical functions.
It provides all its functions and constants inside the table <a name="pdf-math"><code>math</code></a>.
Functions with the annotation "<code>integer/float</code>" give
integer results for integer arguments
and float results for non-integer arguments.
The rounding functions
<a href="#pdf-math.ceil"><code>math.ceil</code></a>, <a href="#pdf-math.floor"><code>math.floor</code></a>, and <a href="#pdf-math.modf"><code>math.modf</code></a>
return an integer when the result fits in the range of an integer,
or a float otherwise.
<p>
<hr><h3><a name="pdf-math.abs"><code>math.abs (x)</code></a></h3>
<p>
Returns the maximum value between <code>x</code> and <code>-x</code>. (integer/float)
<p>
<hr><h3><a name="pdf-math.acos"><code>math.acos (x)</code></a></h3>
<p>
Returns the arc cosine of <code>x</code> (in radians).
<p>
<hr><h3><a name="pdf-math.asin"><code>math.asin (x)</code></a></h3>
<p>
Returns the arc sine of <code>x</code> (in radians).
<p>
<hr><h3><a name="pdf-math.atan"><code>math.atan (y [, x])</code></a></h3>
<p>
Returns the arc tangent of <code>y/x</code> (in radians),
but uses the signs of both arguments to find the
quadrant of the result.
It also handles correctly the case of <code>x</code> being zero.
<p>
The default value for <code>x</code> is 1,
so that the call <code>math.atan(y)</code>
returns the arc tangent of <code>y</code>.
<p>
<hr><h3><a name="pdf-math.ceil"><code>math.ceil (x)</code></a></h3>
<p>
Returns the smallest integral value greater than or equal to <code>x</code>.
<p>
<hr><h3><a name="pdf-math.cos"><code>math.cos (x)</code></a></h3>
<p>
Returns the cosine of <code>x</code> (assumed to be in radians).
<p>
<hr><h3><a name="pdf-math.deg"><code>math.deg (x)</code></a></h3>
<p>
Converts the angle <code>x</code> from radians to degrees.
<p>
<hr><h3><a name="pdf-math.exp"><code>math.exp (x)</code></a></h3>
<p>
Returns the value <em>e<sup>x</sup></em>
(where <code>e</code> is the base of natural logarithms).
<p>
<hr><h3><a name="pdf-math.floor"><code>math.floor (x)</code></a></h3>
<p>
Returns the largest integral value less than or equal to <code>x</code>.
<p>
<hr><h3><a name="pdf-math.fmod"><code>math.fmod (x, y)</code></a></h3>
<p>
Returns the remainder of the division of <code>x</code> by <code>y</code>
that rounds the quotient towards zero. (integer/float)
<p>
<hr><h3><a name="pdf-math.huge"><code>math.huge</code></a></h3>
<p>
The float value <code>HUGE_VAL</code>,
a value greater than any other numeric value.
<p>
<hr><h3><a name="pdf-math.log"><code>math.log (x [, base])</code></a></h3>
<p>
Returns the logarithm of <code>x</code> in the given base.
The default for <code>base</code> is <em>e</em>
(so that the function returns the natural logarithm of <code>x</code>).
<p>
<hr><h3><a name="pdf-math.max"><code>math.max (x, ···)</code></a></h3>
<p>
Returns the argument with the maximum value,
according to the Lua operator <code><</code>.
<p>
<hr><h3><a name="pdf-math.maxinteger"><code>math.maxinteger</code></a></h3>
An integer with the maximum value for an integer.
<p>
<hr><h3><a name="pdf-math.min"><code>math.min (x, ···)</code></a></h3>
<p>
Returns the argument with the minimum value,
according to the Lua operator <code><</code>.
<p>
<hr><h3><a name="pdf-math.mininteger"><code>math.mininteger</code></a></h3>
An integer with the minimum value for an integer.
<p>
<hr><h3><a name="pdf-math.modf"><code>math.modf (x)</code></a></h3>
<p>
Returns the integral part of <code>x</code> and the fractional part of <code>x</code>.
Its second result is always a float.
<p>
<hr><h3><a name="pdf-math.pi"><code>math.pi</code></a></h3>
<p>
The value of <em>π</em>.
<p>
<hr><h3><a name="pdf-math.rad"><code>math.rad (x)</code></a></h3>
<p>
Converts the angle <code>x</code> from degrees to radians.
<p>
<hr><h3><a name="pdf-math.random"><code>math.random ([m [, n]])</code></a></h3>
<p>
When called without arguments,
returns a pseudo-random float with uniform distribution
in the range <em>[0,1)</em>.
When called with two integers <code>m</code> and <code>n</code>,
<code>math.random</code> returns a pseudo-random integer
with uniform distribution in the range <em>[m, n]</em>.
The call <code>math.random(n)</code>, for a positive <code>n</code>,
is equivalent to <code>math.random(1,n)</code>.
The call <code>math.random(0)</code> produces an integer with
all bits (pseudo)random.
<p>
This function uses the <code>xoshiro256**</code> algorithm to produce
pseudo-random 64-bit integers,
which are the results of calls with argument 0.
Other results (ranges and floats)
are unbiased extracted from these integers.
<p>
Lua initializes its pseudo-random generator with the equivalent of
a call to <a href="#pdf-math.randomseed"><code>math.randomseed</code></a> with no arguments,
so that <code>math.random</code> should generate
different sequences of results each time the program runs.
<p>
<hr><h3><a name="pdf-math.randomseed"><code>math.randomseed ([x [, y]])</code></a></h3>
<p>
When called with at least one argument,
the integer parameters <code>x</code> and <code>y</code> are
joined into a 128-bit <em>seed</em> that
is used to reinitialize the pseudo-random generator;
equal seeds produce equal sequences of numbers.
The default for <code>y</code> is zero.
<p>
When called with no arguments,
Lua generates a seed with
a weak attempt for randomness.
<p>
This function returns the two seed components
that were effectively used,
so that setting them again repeats the sequence.
<p>
To ensure a required level of randomness to the initial state
(or contrarily, to have a deterministic sequence,
for instance when debugging a program),
you should call <a href="#pdf-math.randomseed"><code>math.randomseed</code></a> with explicit arguments.
<p>
<hr><h3><a name="pdf-math.sin"><code>math.sin (x)</code></a></h3>
<p>
Returns the sine of <code>x</code> (assumed to be in radians).
<p>
<hr><h3><a name="pdf-math.sqrt"><code>math.sqrt (x)</code></a></h3>
<p>
Returns the square root of <code>x</code>.
(You can also use the expression <code>x^0.5</code> to compute this value.)
<p>
<hr><h3><a name="pdf-math.tan"><code>math.tan (x)</code></a></h3>
<p>
Returns the tangent of <code>x</code> (assumed to be in radians).
<p>
<hr><h3><a name="pdf-math.tointeger"><code>math.tointeger (x)</code></a></h3>
<p>
If the value <code>x</code> is convertible to an integer,
returns that integer.
Otherwise, returns <b>fail</b>.
<p>
<hr><h3><a name="pdf-math.type"><code>math.type (x)</code></a></h3>
<p>
Returns "<code>integer</code>" if <code>x</code> is an integer,
"<code>float</code>" if it is a float,
or <b>fail</b> if <code>x</code> is not a number.
<p>
<hr><h3><a name="pdf-math.ult"><code>math.ult (m, n)</code></a></h3>
<p>
Returns a boolean,
true if and only if integer <code>m</code> is below integer <code>n</code> when
they are compared as unsigned integers.
<h2>6.8 – <a name="6.8">Input and Output Facilities</a></h2>
<p>
The I/O library provides two different styles for file manipulation.
The first one uses implicit file handles;
that is, there are operations to set a default input file and a
default output file,
and all input/output operations are done over these default files.
The second style uses explicit file handles.
<p>
When using implicit file handles,
all operations are supplied by table <a name="pdf-io"><code>io</code></a>.
When using explicit file handles,
the operation <a href="#pdf-io.open"><code>io.open</code></a> returns a file handle
and then all operations are supplied as methods of the file handle.
<p>
The metatable for file handles provides metamethods
for <code>__gc</code> and <code>__close</code> that try
to close the file when called.
<p>
The table <code>io</code> also provides
three predefined file handles with their usual meanings from C:
<a name="pdf-io.stdin"><code>io.stdin</code></a>, <a name="pdf-io.stdout"><code>io.stdout</code></a>, and <a name="pdf-io.stderr"><code>io.stderr</code></a>.
The I/O library never closes these files.
<p>
Unless otherwise stated,
all I/O functions return <b>fail</b> on failure,
plus an error message as a second result and
a system-dependent error code as a third result,
and some non-false value on success.
On non-POSIX systems,
the computation of the error message and error code
in case of errors
may be not thread safe,
because they rely on the global C variable <code>errno</code>.
<p>
<hr><h3><a name="pdf-io.close"><code>io.close ([file])</code></a></h3>
<p>
Equivalent to <code>file:close()</code>.
Without a <code>file</code>, closes the default output file.
<p>
<hr><h3><a name="pdf-io.flush"><code>io.flush ()</code></a></h3>
<p>
Equivalent to <code>io.output():flush()</code>.
<p>
<hr><h3><a name="pdf-io.input"><code>io.input ([file])</code></a></h3>
<p>
When called with a file name, it opens the named file (in text mode),
and sets its handle as the default input file.
When called with a file handle,
it simply sets this file handle as the default input file.
When called without arguments,
it returns the current default input file.
<p>
In case of errors this function raises the error,
instead of returning an error code.
<p>
<hr><h3><a name="pdf-io.lines"><code>io.lines ([filename, ···])</code></a></h3>
<p>
Opens the given file name in read mode
and returns an iterator function that
works like <code>file:lines(···)</code> over the opened file.
When the iterator function fails to read any value,
it automatically closes the file.
Besides the iterator function,
<code>io.lines</code> returns three other values:
two <b>nil</b> values as placeholders,
plus the created file handle.
Therefore, when used in a generic <b>for</b> loop,
the file is closed also if the loop is interrupted by an
error or a <b>break</b>.
<p>
The call <code>io.lines()</code> (with no file name) is equivalent
to <code>io.input():lines("l")</code>;
that is, it iterates over the lines of the default input file.
In this case, the iterator does not close the file when the loop ends.
<p>
In case of errors opening the file,
this function raises the error,
instead of returning an error code.
<p>
<hr><h3><a name="pdf-io.open"><code>io.open (filename [, mode])</code></a></h3>
<p>
This function opens a file,
in the mode specified in the string <code>mode</code>.
In case of success,
it returns a new file handle.
<p>
The <code>mode</code> string can be any of the following:
<ul>
<li><b>"<code>r</code>": </b> read mode (the default);</li>
<li><b>"<code>w</code>": </b> write mode;</li>
<li><b>"<code>a</code>": </b> append mode;</li>
<li><b>"<code>r+</code>": </b> update mode, all previous data is preserved;</li>
<li><b>"<code>w+</code>": </b> update mode, all previous data is erased;</li>
<li><b>"<code>a+</code>": </b> append update mode, previous data is preserved,
writing is only allowed at the end of file.</li>
</ul><p>
The <code>mode</code> string can also have a '<code>b</code>' at the end,
which is needed in some systems to open the file in binary mode.
<p>
<hr><h3><a name="pdf-io.output"><code>io.output ([file])</code></a></h3>
<p>
Similar to <a href="#pdf-io.input"><code>io.input</code></a>, but operates over the default output file.
<p>
<hr><h3><a name="pdf-io.popen"><code>io.popen (prog [, mode])</code></a></h3>
<p>
This function is system dependent and is not available
on all platforms.
<p>
Starts the program <code>prog</code> in a separated process and returns
a file handle that you can use to read data from this program
(if <code>mode</code> is <code>"r"</code>, the default)
or to write data to this program
(if <code>mode</code> is <code>"w"</code>).
<p>
<hr><h3><a name="pdf-io.read"><code>io.read (···)</code></a></h3>
<p>
Equivalent to <code>io.input():read(···)</code>.
<p>
<hr><h3><a name="pdf-io.tmpfile"><code>io.tmpfile ()</code></a></h3>
<p>
In case of success,
returns a handle for a temporary file.
This file is opened in update mode
and it is automatically removed when the program ends.
<p>
<hr><h3><a name="pdf-io.type"><code>io.type (obj)</code></a></h3>
<p>
Checks whether <code>obj</code> is a valid file handle.
Returns the string <code>"file"</code> if <code>obj</code> is an open file handle,
<code>"closed file"</code> if <code>obj</code> is a closed file handle,
or <b>fail</b> if <code>obj</code> is not a file handle.
<p>
<hr><h3><a name="pdf-io.write"><code>io.write (···)</code></a></h3>
<p>
Equivalent to <code>io.output():write(···)</code>.
<p>
<hr><h3><a name="pdf-file:close"><code>file:close ()</code></a></h3>
<p>
Closes <code>file</code>.
Note that files are automatically closed when
their handles are garbage collected,
but that takes an unpredictable amount of time to happen.
<p>
When closing a file handle created with <a href="#pdf-io.popen"><code>io.popen</code></a>,
<a href="#pdf-file:close"><code>file:close</code></a> returns the same values
returned by <a href="#pdf-os.execute"><code>os.execute</code></a>.
<p>
<hr><h3><a name="pdf-file:flush"><code>file:flush ()</code></a></h3>
<p>
Saves any written data to <code>file</code>.
<p>
<hr><h3><a name="pdf-file:lines"><code>file:lines (···)</code></a></h3>
<p>
Returns an iterator function that,
each time it is called,
reads the file according to the given formats.
When no format is given,
uses "<code>l</code>" as a default.
As an example, the construction
<pre>
for c in file:lines(1) do <em>body</em> end
</pre><p>
will iterate over all characters of the file,
starting at the current position.
Unlike <a href="#pdf-io.lines"><code>io.lines</code></a>, this function does not close the file
when the loop ends.
<p>
<hr><h3><a name="pdf-file:read"><code>file:read (···)</code></a></h3>
<p>
Reads the file <code>file</code>,
according to the given formats, which specify what to read.
For each format,
the function returns a string or a number with the characters read,
or <b>fail</b> if it cannot read data with the specified format.
(In this latter case,
the function does not read subsequent formats.)
When called without arguments,
it uses a default format that reads the next line
(see below).
<p>
The available formats are
<ul>
<li><b>"<code>n</code>": </b>
reads a numeral and returns it as a float or an integer,
following the lexical conventions of Lua.
(The numeral may have leading whitespaces and a sign.)
This format always reads the longest input sequence that
is a valid prefix for a numeral;
if that prefix does not form a valid numeral
(e.g., an empty string, "<code>0x</code>", or "<code>3.4e-</code>")
or it is too long (more than 200 characters),
it is discarded and the format returns <b>fail</b>.
</li>
<li><b>"<code>a</code>": </b>
reads the whole file, starting at the current position.
On end of file, it returns the empty string;
this format never fails.
</li>
<li><b>"<code>l</code>": </b>
reads the next line skipping the end of line,
returning <b>fail</b> on end of file.
This is the default format.
</li>
<li><b>"<code>L</code>": </b>
reads the next line keeping the end-of-line character (if present),
returning <b>fail</b> on end of file.
</li>
<li><b><em>number</em>: </b>
reads a string with up to this number of bytes,
returning <b>fail</b> on end of file.
If <code>number</code> is zero,
it reads nothing and returns an empty string,
or <b>fail</b> on end of file.
</li>
</ul><p>
The formats "<code>l</code>" and "<code>L</code>" should be used only for text files.
<p>
<hr><h3><a name="pdf-file:seek"><code>file:seek ([whence [, offset]])</code></a></h3>
<p>
Sets and gets the file position,
measured from the beginning of the file,
to the position given by <code>offset</code> plus a base
specified by the string <code>whence</code>, as follows:
<ul>
<li><b>"<code>set</code>": </b> base is position 0 (beginning of the file);</li>
<li><b>"<code>cur</code>": </b> base is current position;</li>
<li><b>"<code>end</code>": </b> base is end of file;</li>
</ul><p>
In case of success, <code>seek</code> returns the final file position,
measured in bytes from the beginning of the file.
If <code>seek</code> fails, it returns <b>fail</b>,
plus a string describing the error.
<p>
The default value for <code>whence</code> is <code>"cur"</code>,
and for <code>offset</code> is 0.
Therefore, the call <code>file:seek()</code> returns the current
file position, without changing it;
the call <code>file:seek("set")</code> sets the position to the
beginning of the file (and returns 0);
and the call <code>file:seek("end")</code> sets the position to the
end of the file, and returns its size.
<p>
<hr><h3><a name="pdf-file:setvbuf"><code>file:setvbuf (mode [, size])</code></a></h3>
<p>
Sets the buffering mode for a file.
There are three available modes:
<ul>
<li><b>"<code>no</code>": </b> no buffering.</li>
<li><b>"<code>full</code>": </b> full buffering.</li>
<li><b>"<code>line</code>": </b> line buffering.</li>
</ul>
<p>
For the last two cases,
<code>size</code> is a hint for the size of the buffer, in bytes.
The default is an appropriate size.
<p>
The specific behavior of each mode is non portable;
check the underlying ISO C function <code>setvbuf</code> in your platform for
more details.
<p>
<hr><h3><a name="pdf-file:write"><code>file:write (···)</code></a></h3>
<p>
Writes the value of each of its arguments to <code>file</code>.
The arguments must be strings or numbers.
<p>
In case of success, this function returns <code>file</code>.
<h2>6.9 – <a name="6.9">Operating System Facilities</a></h2>
<p>
This library is implemented through table <a name="pdf-os"><code>os</code></a>.
<p>
<hr><h3><a name="pdf-os.clock"><code>os.clock ()</code></a></h3>
<p>
Returns an approximation of the amount in seconds of CPU time
used by the program,
as returned by the underlying ISO C function <code>clock</code>.
<p>
<hr><h3><a name="pdf-os.date"><code>os.date ([format [, time]])</code></a></h3>
<p>
Returns a string or a table containing date and time,
formatted according to the given string <code>format</code>.
<p>
If the <code>time</code> argument is present,
this is the time to be formatted
(see the <a href="#pdf-os.time"><code>os.time</code></a> function for a description of this value).
Otherwise, <code>date</code> formats the current time.
<p>
If <code>format</code> starts with '<code>!</code>',
then the date is formatted in Coordinated Universal Time.
After this optional character,
if <code>format</code> is the string "<code>*t</code>",
then <code>date</code> returns a table with the following fields:
<code>year</code>, <code>month</code> (1–12), <code>day</code> (1–31),
<code>hour</code> (0–23), <code>min</code> (0–59),
<code>sec</code> (0–61, due to leap seconds),
<code>wday</code> (weekday, 1–7, Sunday is 1),
<code>yday</code> (day of the year, 1–366),
and <code>isdst</code> (daylight saving flag, a boolean).
This last field may be absent
if the information is not available.
<p>
If <code>format</code> is not "<code>*t</code>",
then <code>date</code> returns the date as a string,
formatted according to the same rules as the ISO C function <code>strftime</code>.
<p>
If <code>format</code> is absent, it defaults to "<code>%c</code>",
which gives a human-readable date and time representation
using the current locale.
<p>
On non-POSIX systems,
this function may be not thread safe
because of its reliance on C function <code>gmtime</code> and C function <code>localtime</code>.
<p>
<hr><h3><a name="pdf-os.difftime"><code>os.difftime (t2, t1)</code></a></h3>
<p>
Returns the difference, in seconds,
from time <code>t1</code> to time <code>t2</code>
(where the times are values returned by <a href="#pdf-os.time"><code>os.time</code></a>).
In POSIX, Windows, and some other systems,
this value is exactly <code>t2</code><em>-</em><code>t1</code>.
<p>
<hr><h3><a name="pdf-os.execute"><code>os.execute ([command])</code></a></h3>
<p>
This function is equivalent to the ISO C function <code>system</code>.
It passes <code>command</code> to be executed by an operating system shell.
Its first result is <b>true</b>
if the command terminated successfully,
or <b>fail</b> otherwise.
After this first result
the function returns a string plus a number,
as follows:
<ul>
<li><b>"<code>exit</code>": </b>
the command terminated normally;
the following number is the exit status of the command.
</li>
<li><b>"<code>signal</code>": </b>
the command was terminated by a signal;
the following number is the signal that terminated the command.
</li>
</ul>
<p>
When called without a <code>command</code>,
<code>os.execute</code> returns a boolean that is true if a shell is available.
<p>
<hr><h3><a name="pdf-os.exit"><code>os.exit ([code [, close]])</code></a></h3>
<p>
Calls the ISO C function <code>exit</code> to terminate the host program.
If <code>code</code> is <b>true</b>,
the returned status is <code>EXIT_SUCCESS</code>;
if <code>code</code> is <b>false</b>,
the returned status is <code>EXIT_FAILURE</code>;
if <code>code</code> is a number,
the returned status is this number.
The default value for <code>code</code> is <b>true</b>.
<p>
If the optional second argument <code>close</code> is true,
closes the Lua state before exiting.
<p>
<hr><h3><a name="pdf-os.getenv"><code>os.getenv (varname)</code></a></h3>
<p>
Returns the value of the process environment variable <code>varname</code>
or <b>fail</b> if the variable is not defined.
<p>
<hr><h3><a name="pdf-os.remove"><code>os.remove (filename)</code></a></h3>
<p>
Deletes the file (or empty directory, on POSIX systems)
with the given name.
If this function fails, it returns <b>fail</b>
plus a string describing the error and the error code.
Otherwise, it returns true.
<p>
<hr><h3><a name="pdf-os.rename"><code>os.rename (oldname, newname)</code></a></h3>
<p>
Renames the file or directory named <code>oldname</code> to <code>newname</code>.
If this function fails, it returns <b>fail</b>,
plus a string describing the error and the error code.
Otherwise, it returns true.
<p>
<hr><h3><a name="pdf-os.setlocale"><code>os.setlocale (locale [, category])</code></a></h3>
<p>
Sets the current locale of the program.
<code>locale</code> is a system-dependent string specifying a locale;
<code>category</code> is an optional string describing which category to change:
<code>"all"</code>, <code>"collate"</code>, <code>"ctype"</code>,
<code>"monetary"</code>, <code>"numeric"</code>, or <code>"time"</code>;
the default category is <code>"all"</code>.
The function returns the name of the new locale,
or <b>fail</b> if the request cannot be honored.
<p>
If <code>locale</code> is the empty string,
the current locale is set to an implementation-defined native locale.
If <code>locale</code> is the string "<code>C</code>",
the current locale is set to the standard C locale.
<p>
When called with <b>nil</b> as the first argument,
this function only returns the name of the current locale
for the given category.
<p>
This function may be not thread safe
because of its reliance on C function <code>setlocale</code>.
<p>
<hr><h3><a name="pdf-os.time"><code>os.time ([table])</code></a></h3>
<p>
Returns the current time when called without arguments,
or a time representing the local date and time specified by the given table.
This table must have fields <code>year</code>, <code>month</code>, and <code>day</code>,
and may have fields
<code>hour</code> (default is 12),
<code>min</code> (default is 0),
<code>sec</code> (default is 0),
and <code>isdst</code> (default is <b>nil</b>).
Other fields are ignored.
For a description of these fields, see the <a href="#pdf-os.date"><code>os.date</code></a> function.
<p>
When the function is called,
the values in these fields do not need to be inside their valid ranges.
For instance, if <code>sec</code> is -10,
it means 10 seconds before the time specified by the other fields;
if <code>hour</code> is 1000,
it means 1000 hours after the time specified by the other fields.
<p>
The returned value is a number, whose meaning depends on your system.
In POSIX, Windows, and some other systems,
this number counts the number
of seconds since some given start time (the "epoch").
In other systems, the meaning is not specified,
and the number returned by <code>time</code> can be used only as an argument to
<a href="#pdf-os.date"><code>os.date</code></a> and <a href="#pdf-os.difftime"><code>os.difftime</code></a>.
<p>
When called with a table,
<code>os.time</code> also normalizes all the fields
documented in the <a href="#pdf-os.date"><code>os.date</code></a> function,
so that they represent the same time as before the call
but with values inside their valid ranges.
<p>
<hr><h3><a name="pdf-os.tmpname"><code>os.tmpname ()</code></a></h3>
<p>
Returns a string with a file name that can
be used for a temporary file.
The file must be explicitly opened before its use
and explicitly removed when no longer needed.
<p>
In POSIX systems,
this function also creates a file with that name,
to avoid security risks.
(Someone else might create the file with wrong permissions
in the time between getting the name and creating the file.)
You still have to open the file to use it
and to remove it (even if you do not use it).
<p>
When possible,
you may prefer to use <a href="#pdf-io.tmpfile"><code>io.tmpfile</code></a>,
which automatically removes the file when the program ends.
<h2>6.10 – <a name="6.10">The Debug Library</a></h2>
<p>
This library provides
the functionality of the debug interface (<a href="#4.7">§4.7</a>) to Lua programs.
You should exert care when using this library.
Several of its functions
violate basic assumptions about Lua code
(e.g., that variables local to a function
cannot be accessed from outside;
that userdata metatables cannot be changed by Lua code;
that Lua programs do not crash)
and therefore can compromise otherwise secure code.
Moreover, some functions in this library may be slow.
<p>
All functions in this library are provided
inside the <a name="pdf-debug"><code>debug</code></a> table.
All functions that operate over a thread
have an optional first argument which is the
thread to operate over.
The default is always the current thread.
<p>
<hr><h3><a name="pdf-debug.debug"><code>debug.debug ()</code></a></h3>
<p>
Enters an interactive mode with the user,
running each string that the user enters.
Using simple commands and other debug facilities,
the user can inspect global and local variables,
change their values, evaluate expressions, and so on.
A line containing only the word <code>cont</code> finishes this function,
so that the caller continues its execution.
<p>
Note that commands for <code>debug.debug</code> are not lexically nested
within any function and so have no direct access to local variables.
<p>
<hr><h3><a name="pdf-debug.gethook"><code>debug.gethook ([thread])</code></a></h3>
<p>
Returns the current hook settings of the thread, as three values:
the current hook function, the current hook mask,
and the current hook count,
as set by the <a href="#pdf-debug.sethook"><code>debug.sethook</code></a> function.
<p>
Returns <b>fail</b> if there is no active hook.
<p>
<hr><h3><a name="pdf-debug.getinfo"><code>debug.getinfo ([thread,] f [, what])</code></a></h3>
<p>
Returns a table with information about a function.
You can give the function directly
or you can give a number as the value of <code>f</code>,
which means the function running at level <code>f</code> of the call stack
of the given thread:
level 0 is the current function (<code>getinfo</code> itself);
level 1 is the function that called <code>getinfo</code>
(except for tail calls, which do not count in the stack);
and so on.
If <code>f</code> is a number greater than the number of active functions,
then <code>getinfo</code> returns <b>fail</b>.
<p>
The returned table can contain all the fields returned by <a href="#lua_getinfo"><code>lua_getinfo</code></a>,
with the string <code>what</code> describing which fields to fill in.
The default for <code>what</code> is to get all information available,
except the table of valid lines.
If present,
the option '<code>f</code>'
adds a field named <code>func</code> with the function itself.
If present,
the option '<code>L</code>'
adds a field named <code>activelines</code> with the table of
valid lines.
<p>
For instance, the expression <code>debug.getinfo(1,"n").name</code> returns
a name for the current function,
if a reasonable name can be found,
and the expression <code>debug.getinfo(print)</code>
returns a table with all available information
about the <a href="#pdf-print"><code>print</code></a> function.
<p>
<hr><h3><a name="pdf-debug.getlocal"><code>debug.getlocal ([thread,] f, local)</code></a></h3>
<p>
This function returns the name and the value of the local variable
with index <code>local</code> of the function at level <code>f</code> of the stack.
This function accesses not only explicit local variables,
but also parameters and temporary values.
<p>
The first parameter or local variable has index 1, and so on,
following the order that they are declared in the code,
counting only the variables that are active
in the current scope of the function.
Compile-time constants may not appear in this listing,
if they were optimized away by the compiler.
Negative indices refer to vararg arguments;
-1 is the first vararg argument.
The function returns <b>fail</b>
if there is no variable with the given index,
and raises an error when called with a level out of range.
(You can call <a href="#pdf-debug.getinfo"><code>debug.getinfo</code></a> to check whether the level is valid.)
<p>
Variable names starting with '<code>(</code>' (open parenthesis)
represent variables with no known names
(internal variables such as loop control variables,
and variables from chunks saved without debug information).
<p>
The parameter <code>f</code> may also be a function.
In that case, <code>getlocal</code> returns only the name of function parameters.
<p>
<hr><h3><a name="pdf-debug.getmetatable"><code>debug.getmetatable (value)</code></a></h3>
<p>
Returns the metatable of the given <code>value</code>
or <b>nil</b> if it does not have a metatable.
<p>
<hr><h3><a name="pdf-debug.getregistry"><code>debug.getregistry ()</code></a></h3>
<p>
Returns the registry table (see <a href="#4.3">§4.3</a>).
<p>
<hr><h3><a name="pdf-debug.getupvalue"><code>debug.getupvalue (f, up)</code></a></h3>
<p>
This function returns the name and the value of the upvalue
with index <code>up</code> of the function <code>f</code>.
The function returns <b>fail</b>
if there is no upvalue with the given index.
<p>
(For Lua functions,
upvalues are the external local variables that the function uses,
and that are consequently included in its closure.)
<p>
For C functions, this function uses the empty string <code>""</code>
as a name for all upvalues.
<p>
Variable name '<code>?</code>' (interrogation mark)
represents variables with no known names
(variables from chunks saved without debug information).
<p>
<hr><h3><a name="pdf-debug.getuservalue"><code>debug.getuservalue (u, n)</code></a></h3>
<p>
Returns the <code>n</code>-th user value associated
to the userdata <code>u</code> plus a boolean,
<b>false</b> if the userdata does not have that value.
<p>
<hr><h3><a name="pdf-debug.sethook"><code>debug.sethook ([thread,] hook, mask [, count])</code></a></h3>
<p>
Sets the given function as the debug hook.
The string <code>mask</code> and the number <code>count</code> describe
when the hook will be called.
The string mask may have any combination of the following characters,
with the given meaning:
<ul>
<li><b>'<code>c</code>': </b> the hook is called every time Lua calls a function;</li>
<li><b>'<code>r</code>': </b> the hook is called every time Lua returns from a function;</li>
<li><b>'<code>l</code>': </b> the hook is called every time Lua enters a new line of code.</li>
</ul><p>
Moreover,
with a <code>count</code> different from zero,
the hook is called also after every <code>count</code> instructions.
<p>
When called without arguments,
<a href="#pdf-debug.sethook"><code>debug.sethook</code></a> turns off the hook.
<p>
When the hook is called, its first parameter is a string
describing the event that has triggered its call:
<code>"call"</code>, <code>"tail call"</code>, <code>"return"</code>,
<code>"line"</code>, and <code>"count"</code>.
For line events,
the hook also gets the new line number as its second parameter.
Inside a hook,
you can call <code>getinfo</code> with level 2 to get more information about
the running function.
(Level 0 is the <code>getinfo</code> function,
and level 1 is the hook function.)
<p>
<hr><h3><a name="pdf-debug.setlocal"><code>debug.setlocal ([thread,] level, local, value)</code></a></h3>
<p>
This function assigns the value <code>value</code> to the local variable
with index <code>local</code> of the function at level <code>level</code> of the stack.
The function returns <b>fail</b> if there is no local
variable with the given index,
and raises an error when called with a <code>level</code> out of range.
(You can call <code>getinfo</code> to check whether the level is valid.)
Otherwise, it returns the name of the local variable.
<p>
See <a href="#pdf-debug.getlocal"><code>debug.getlocal</code></a> for more information about
variable indices and names.
<p>
<hr><h3><a name="pdf-debug.setmetatable"><code>debug.setmetatable (value, table)</code></a></h3>
<p>
Sets the metatable for the given <code>value</code> to the given <code>table</code>
(which can be <b>nil</b>).
Returns <code>value</code>.
<p>
<hr><h3><a name="pdf-debug.setupvalue"><code>debug.setupvalue (f, up, value)</code></a></h3>
<p>
This function assigns the value <code>value</code> to the upvalue
with index <code>up</code> of the function <code>f</code>.
The function returns <b>fail</b> if there is no upvalue
with the given index.
Otherwise, it returns the name of the upvalue.
<p>
See <a href="#pdf-debug.getupvalue"><code>debug.getupvalue</code></a> for more information about upvalues.
<p>
<hr><h3><a name="pdf-debug.setuservalue"><code>debug.setuservalue (udata, value, n)</code></a></h3>
<p>
Sets the given <code>value</code> as
the <code>n</code>-th user value associated to the given <code>udata</code>.
<code>udata</code> must be a full userdata.
<p>
Returns <code>udata</code>,
or <b>fail</b> if the userdata does not have that value.
<p>
<hr><h3><a name="pdf-debug.traceback"><code>debug.traceback ([thread,] [message [, level]])</code></a></h3>
<p>
If <code>message</code> is present but is neither a string nor <b>nil</b>,
this function returns <code>message</code> without further processing.
Otherwise,
it returns a string with a traceback of the call stack.
The optional <code>message</code> string is appended
at the beginning of the traceback.
An optional <code>level</code> number tells at which level
to start the traceback
(default is 1, the function calling <code>traceback</code>).
<p>
<hr><h3><a name="pdf-debug.upvalueid"><code>debug.upvalueid (f, n)</code></a></h3>
<p>
Returns a unique identifier (as a light userdata)
for the upvalue numbered <code>n</code>
from the given function.
<p>
These unique identifiers allow a program to check whether different
closures share upvalues.
Lua closures that share an upvalue
(that is, that access a same external local variable)
will return identical ids for those upvalue indices.
<p>
<hr><h3><a name="pdf-debug.upvaluejoin"><code>debug.upvaluejoin (f1, n1, f2, n2)</code></a></h3>
<p>
Make the <code>n1</code>-th upvalue of the Lua closure <code>f1</code>
refer to the <code>n2</code>-th upvalue of the Lua closure <code>f2</code>.
<h1>7 – <a name="7">Lua Standalone</a></h1>
<p>
Although Lua has been designed as an extension language,
to be embedded in a host C program,
it is also frequently used as a standalone language.
An interpreter for Lua as a standalone language,
called simply <code>lua</code>,
is provided with the standard distribution.
The standalone interpreter includes
all standard libraries.
Its usage is:
<pre>
lua [options] [script [args]]
</pre><p>
The options are:
<ul>
<li><b><code>-e <em>stat</em></code>: </b> execute string <em>stat</em>;</li>
<li><b><code>-i</code>: </b> enter interactive mode after running <em>script</em>;</li>
<li><b><code>-l <em>mod</em></code>: </b> "require" <em>mod</em> and assign the
result to global <em>mod</em>;</li>
<li><b><code>-v</code>: </b> print version information;</li>
<li><b><code>-E</code>: </b> ignore environment variables;</li>
<li><b><code>-W</code>: </b> turn warnings on;</li>
<li><b><code>--</code>: </b> stop handling options;</li>
<li><b><code>-</code>: </b> execute <code>stdin</code> as a file and stop handling options.</li>
</ul><p>
After handling its options, <code>lua</code> runs the given <em>script</em>.
When called without arguments,
<code>lua</code> behaves as <code>lua -v -i</code>
when the standard input (<code>stdin</code>) is a terminal,
and as <code>lua -</code> otherwise.
<p>
When called without the option <code>-E</code>,
the interpreter checks for an environment variable <a name="pdf-LUA_INIT_5_4"><code>LUA_INIT_5_4</code></a>
(or <a name="pdf-LUA_INIT"><code>LUA_INIT</code></a> if the versioned name is not defined)
before running any argument.
If the variable content has the format <code>@<em>filename</em></code>,
then <code>lua</code> executes the file.
Otherwise, <code>lua</code> executes the string itself.
<p>
When called with the option <code>-E</code>,
Lua does not consult any environment variables.
In particular,
the values of <a href="#pdf-package.path"><code>package.path</code></a> and <a href="#pdf-package.cpath"><code>package.cpath</code></a>
are set with the default paths defined in <code>luaconf.h</code>.
<p>
The options <code>-e</code>, <code>-l</code>, and <code>-W</code> are handled in
the order they appear.
For instance, an invocation like
<pre>
$ lua -e 'a=1' -llib1 script.lua
</pre><p>
will first set <code>a</code> to 1, then require the library <code>lib1</code>,
and finally run the file <code>script.lua</code> with no arguments.
(Here <code>$</code> is the shell prompt. Your prompt may be different.)
<p>
Before running any code,
<code>lua</code> collects all command-line arguments
in a global table called <code>arg</code>.
The script name goes to index 0,
the first argument after the script name goes to index 1,
and so on.
Any arguments before the script name
(that is, the interpreter name plus its options)
go to negative indices.
For instance, in the call
<pre>
$ lua -la b.lua t1 t2
</pre><p>
the table is like this:
<pre>
arg = { [-2] = "lua", [-1] = "-la",
[0] = "b.lua",
[1] = "t1", [2] = "t2" }
</pre><p>
If there is no script in the call,
the interpreter name goes to index 0,
followed by the other arguments.
For instance, the call
<pre>
$ lua -e "print(arg[1])"
</pre><p>
will print "<code>-e</code>".
If there is a script,
the script is called with arguments
<code>arg[1]</code>, ···, <code>arg[#arg]</code>.
Like all chunks in Lua,
the script is compiled as a vararg function.
<p>
In interactive mode,
Lua repeatedly prompts and waits for a line.
After reading a line,
Lua first try to interpret the line as an expression.
If it succeeds, it prints its value.
Otherwise, it interprets the line as a statement.
If you write an incomplete statement,
the interpreter waits for its completion
by issuing a different prompt.
<p>
If the global variable <a name="pdf-_PROMPT"><code>_PROMPT</code></a> contains a string,
then its value is used as the prompt.
Similarly, if the global variable <a name="pdf-_PROMPT2"><code>_PROMPT2</code></a> contains a string,
its value is used as the secondary prompt
(issued during incomplete statements).
<p>
In case of unprotected errors in the script,
the interpreter reports the error to the standard error stream.
If the error object is not a string but
has a metamethod <code>__tostring</code>,
the interpreter calls this metamethod to produce the final message.
Otherwise, the interpreter converts the error object to a string
and adds a stack traceback to it.
When warnings are on,
they are simply printed in the standard error output.
<p>
When finishing normally,
the interpreter closes its main Lua state
(see <a href="#lua_close"><code>lua_close</code></a>).
The script can avoid this step by
calling <a href="#pdf-os.exit"><code>os.exit</code></a> to terminate.
<p>
To allow the use of Lua as a
script interpreter in Unix systems,
Lua skips the first line of a file chunk if it starts with <code>#</code>.
Therefore, Lua scripts can be made into executable programs
by using <code>chmod +x</code> and the <code>#!</code> form,
as in
<pre>
#!/usr/local/bin/lua
</pre><p>
Of course,
the location of the Lua interpreter may be different in your machine.
If <code>lua</code> is in your <code>PATH</code>,
then
<pre>
#!/usr/bin/env lua
</pre><p>
is a more portable solution.
<h1>8 – <a name="8">Incompatibilities with the Previous Version</a></h1>
<p>
Here we list the incompatibilities that you may find when moving a program
from Lua 5.3 to Lua 5.4.
<p>
You can avoid some incompatibilities by compiling Lua with
appropriate options (see file <code>luaconf.h</code>).
However,
all these compatibility options will be removed in the future.
More often than not,
compatibility issues arise when these compatibility options
are removed.
So, whenever you have the chance,
you should try to test your code with a version of Lua compiled
with all compatibility options turned off.
That will ease transitions to newer versions of Lua.
<p>
Lua versions can always change the C API in ways that
do not imply source-code changes in a program,
such as the numeric values for constants
or the implementation of functions as macros.
Therefore,
you should never assume that binaries are compatible between
different Lua versions.
Always recompile clients of the Lua API when
using a new version.
<p>
Similarly, Lua versions can always change the internal representation
of precompiled chunks;
precompiled chunks are not compatible between different Lua versions.
<p>
The standard paths in the official distribution may
change between versions.
<h2>8.1 – <a name="8.1">Incompatibilities in the Language</a></h2>
<ul>
<li>
The coercion of strings to numbers in
arithmetic and bitwise operations
has been removed from the core language.
The string library does a similar job
for arithmetic (but not for bitwise) operations
using the string metamethods.
However, unlike in previous versions,
the new implementation preserves the implicit type of the numeral
in the string.
For instance, the result of <code>"1" + "2"</code> now is an integer,
not a float.
</li>
<li>
Literal decimal integer constants that overflow are read as floats,
instead of wrapping around.
You can use hexadecimal notation for such constants if you
want the old behavior
(reading them as integers with wrap around).
</li>
<li>
The use of the <code>__lt</code> metamethod to emulate <code>__le</code>
has been removed.
When needed, this metamethod must be explicitly defined.
</li>
<li>
The semantics of the numerical <b>for</b> loop
over integers changed in some details.
In particular, the control variable never wraps around.
</li>
<li>
A label for a <b>goto</b> cannot be declared where a label with the same
name is visible, even if this other label is declared in an enclosing
block.
</li>
<li>
When finalizing an object,
Lua does not ignore <code>__gc</code> metamethods that are not functions.
Any value will be called, if present.
(Non-callable values will generate a warning,
like any other error when calling a finalizer.)
</li>
</ul>
<h2>8.2 – <a name="8.2">Incompatibilities in the Libraries</a></h2>
<ul>
<li>
The function <a href="#pdf-print"><code>print</code></a> does not call <a href="#pdf-tostring"><code>tostring</code></a>
to format its arguments;
instead, it has this functionality hardwired.
You should use <code>__tostring</code> to modify how values are printed.
</li>
<li>
The pseudo-random number generator used by the function <a href="#pdf-math.random"><code>math.random</code></a>
now starts with a somewhat random seed.
Moreover, it uses a different algorithm.
</li>
<li>
By default, the decoding functions in the <a href="#pdf-utf8"><code>utf8</code></a> library
do not accept surrogates as valid code points.
An extra parameter in these functions makes them more permissive.
</li>
<li>
The options "<code>setpause</code>" and "<code>setstepmul</code>"
of the function <a href="#pdf-collectgarbage"><code>collectgarbage</code></a> are deprecated.
You should use the new option "<code>incremental</code>" to set them.
</li>
<li>
The function <a href="#pdf-io.lines"><code>io.lines</code></a> now returns four values,
instead of just one.
That can be a problem when it is used as the sole
argument to another function that has optional parameters,
such as in <code>load(io.lines(filename, "L"))</code>.
To fix that issue,
you can wrap the call into parentheses,
to adjust its number of results to one.
</li>
</ul>
<h2>8.3 – <a name="8.3">Incompatibilities in the API</a></h2>
<ul>
<li>
Full userdata now has an arbitrary number of associated user values.
Therefore, the functions <code>lua_newuserdata</code>,
<code>lua_setuservalue</code>, and <code>lua_getuservalue</code> were
replaced by <a href="#lua_newuserdatauv"><code>lua_newuserdatauv</code></a>,
<a href="#lua_setiuservalue"><code>lua_setiuservalue</code></a>, and <a href="#lua_getiuservalue"><code>lua_getiuservalue</code></a>,
which have an extra argument.
<p>
For compatibility, the old names still work as macros assuming
one single user value.
Note, however, that userdata with zero user values
are more efficient memory-wise.
</li>
<li>
The function <a href="#lua_resume"><code>lua_resume</code></a> has an extra parameter.
This out parameter returns the number of values on
the top of the stack that were yielded or returned by the coroutine.
(In previous versions,
those values were the entire stack.)
</li>
<li>
The function <a href="#lua_version"><code>lua_version</code></a> returns the version number,
instead of an address of the version number.
The Lua core should work correctly with libraries using their
own static copies of the same core,
so there is no need to check whether they are using the same
address space.
</li>
<li>
The constant <code>LUA_ERRGCMM</code> was removed.
Errors in finalizers are never propagated;
instead, they generate a warning.
</li>
<li>
The options <code>LUA_GCSETPAUSE</code> and <code>LUA_GCSETSTEPMUL</code>
of the function <a href="#lua_gc"><code>lua_gc</code></a> are deprecated.
You should use the new option <code>LUA_GCINC</code> to set them.
</li>
</ul>
<h1>9 – <a name="9">The Complete Syntax of Lua</a></h1>
<p>
Here is the complete syntax of Lua in extended BNF.
As usual in extended BNF,
{A} means 0 or more As,
and [A] means an optional A.
(For operator precedences, see <a href="#3.4.8">§3.4.8</a>;
for a description of the terminals
Name, Numeral,
and LiteralString, see <a href="#3.1">§3.1</a>.)
<pre>
chunk ::= block
block ::= {stat} [retstat]
stat ::= ‘<b>;</b>’ |
varlist ‘<b>=</b>’ explist |
functioncall |
label |
<b>break</b> |
<b>goto</b> Name |
<b>do</b> block <b>end</b> |
<b>while</b> exp <b>do</b> block <b>end</b> |
<b>repeat</b> block <b>until</b> exp |
<b>if</b> exp <b>then</b> block {<b>elseif</b> exp <b>then</b> block} [<b>else</b> block] <b>end</b> |
<b>for</b> Name ‘<b>=</b>’ exp ‘<b>,</b>’ exp [‘<b>,</b>’ exp] <b>do</b> block <b>end</b> |
<b>for</b> namelist <b>in</b> explist <b>do</b> block <b>end</b> |
<b>function</b> funcname funcbody |
<b>local</b> <b>function</b> Name funcbody |
<b>local</b> attnamelist [‘<b>=</b>’ explist]
attnamelist ::= Name attrib {‘<b>,</b>’ Name attrib}
attrib ::= [‘<b><</b>’ Name ‘<b>></b>’]
retstat ::= <b>return</b> [explist] [‘<b>;</b>’]
label ::= ‘<b>::</b>’ Name ‘<b>::</b>’
funcname ::= Name {‘<b>.</b>’ Name} [‘<b>:</b>’ Name]
varlist ::= var {‘<b>,</b>’ var}
var ::= Name | prefixexp ‘<b>[</b>’ exp ‘<b>]</b>’ | prefixexp ‘<b>.</b>’ Name
namelist ::= Name {‘<b>,</b>’ Name}
explist ::= exp {‘<b>,</b>’ exp}
exp ::= <b>nil</b> | <b>false</b> | <b>true</b> | Numeral | LiteralString | ‘<b>...</b>’ | functiondef |
prefixexp | tableconstructor | exp binop exp | unop exp
prefixexp ::= var | functioncall | ‘<b>(</b>’ exp ‘<b>)</b>’
functioncall ::= prefixexp args | prefixexp ‘<b>:</b>’ Name args
args ::= ‘<b>(</b>’ [explist] ‘<b>)</b>’ | tableconstructor | LiteralString
functiondef ::= <b>function</b> funcbody
funcbody ::= ‘<b>(</b>’ [parlist] ‘<b>)</b>’ block <b>end</b>
parlist ::= namelist [‘<b>,</b>’ ‘<b>...</b>’] | ‘<b>...</b>’
tableconstructor ::= ‘<b>{</b>’ [fieldlist] ‘<b>}</b>’
fieldlist ::= field {fieldsep field} [fieldsep]
field ::= ‘<b>[</b>’ exp ‘<b>]</b>’ ‘<b>=</b>’ exp | Name ‘<b>=</b>’ exp | exp
fieldsep ::= ‘<b>,</b>’ | ‘<b>;</b>’
binop ::= ‘<b>+</b>’ | ‘<b>-</b>’ | ‘<b>*</b>’ | ‘<b>/</b>’ | ‘<b>//</b>’ | ‘<b>^</b>’ | ‘<b>%</b>’ |
‘<b>&</b>’ | ‘<b>~</b>’ | ‘<b>|</b>’ | ‘<b>>></b>’ | ‘<b><<</b>’ | ‘<b>..</b>’ |
‘<b><</b>’ | ‘<b><=</b>’ | ‘<b>></b>’ | ‘<b>>=</b>’ | ‘<b>==</b>’ | ‘<b>~=</b>’ |
<b>and</b> | <b>or</b>
unop ::= ‘<b>-</b>’ | <b>not</b> | ‘<b>#</b>’ | ‘<b>~</b>’
</pre>
<p>
<P CLASS="footer">
Last update:
Mon Mar 15 13:39:42 UTC 2021
</P>
<!--
Last change: revised for Lua 5.4.3
-->
</body></html>
```
|
```objective-c
////////////////////////////////////////////////////////////////////////////////////////////////////
//
// Project: Embedded Learning Library (ELL)
// File: Vector_test.h (value)
// Authors: Kern Handa
//
////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma once
#include <value/include/Scalar.h>
namespace ell
{
value::Scalar Vector_test1();
value::Scalar Vector_test2();
value::Scalar Vector_test3();
value::Scalar Vector_test4();
value::Scalar Vector_test5();
} // namespace ell
```
|
```php
<?php
return [
'Select' => 'Pilih',
'Deselect_All' => 'Deselect All',
'Select_All' => 'Select All',
'Erase' => 'Hapus',
'Open' => 'Buka',
'Confirm_del' => 'Apakah anda yakin menghapus berkas ini?',
'All' => 'Semua',
'Files' => 'Berkas',
'Images' => 'Gambar',
'Archives' => 'Arsip',
'Error_Upload' => 'Berkas yang diubah melebihi batas ukuran yang diperbolehkan.',
'Error_extension' => 'Ekstensi berkas tidak diperbolehkan.',
'Upload_file' => 'Unggah',
'Filters' => 'Saring',
'Videos' => 'Video',
'Music' => 'Musik',
'New_Folder' => 'Folder Baru',
'Folder_Created' => 'Folder Telah Dibuat',
'Existing_Folder' => 'Folder yang ada',
'Confirm_Folder_del' => 'Apakah anda yakin menghapus folder dan semua isi didalamnya?',
'Return_Files_List' => 'Kembali ke daftar',
'Preview' => 'Pratampil',
'Download' => 'Unduh',
'Insert_Folder_Name' => 'Masukkan nama folder:',
'Root' => 'root',
'Rename' => 'Ubah nama',
'Back' => 'kembali',
'View' => 'lihat',
'View_list' => 'Tampilan Daftar',
'View_columns_list' => 'Tampilan Daftar kolom',
'View_boxes' => 'Tampilan Kotak',
'Toolbar' => 'Toolbar',
'Actions' => 'Aksi',
'Rename_existing_file' => 'Berkas Sudah ada',
'Rename_existing_folder' => 'Folder sudah ada',
'Empty_name' => 'Nama Kosong',
'Text_filter' => 'saring teks',
'Swipe_help' => 'Arahkan pada nama berkas/folder untuk melihat pilihan',
'Upload_base' => 'Basis Unggah',
'Upload_base_help' => "Drag & Drop files(modern browsers) or click in upper button to Add the file(s) and click on Start upload. When the upload is complete, click the 'Return to files list' button.",
'Upload_add_files' => 'Add file(s)',
'Upload_start' => 'Start upload',
'Upload_error_messages' =>[1 => 'The uploaded file exceeds the upload_max_filesize directive in php.ini', 2 => 'The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form', 3 => 'The uploaded file was only partially uploaded', 4 => 'No file was uploaded', 6 => 'Missing a temporary folder', 7 => 'Failed to write file to disk', 8 => 'A PHP extension stopped the file upload', 'post_max_size' => 'The uploaded file exceeds the post_max_size directive in php.ini', 'max_file_size' => 'File is too big', 'min_file_size' => 'File is too small', 'accept_file_types' => 'Filetype not allowed', 'max_number_of_files' => 'Maximum number of files exceeded', 'max_width' => 'Image exceeds maximum width', 'min_width' => 'Image requires a minimum width', 'max_height' => 'Image exceeds maximum height', 'min_height' => 'Image requires a minimum height', 'abort' => 'File upload aborted', 'image_resize' => 'Failed to resize image'],
'Upload_url' => 'From url',
'Type_dir' => 'direktori',
'Type' => 'Tipe',
'Dimension' => 'Dimensi',
'Size' => 'Ukuran',
'Date' => 'Tanggal',
'Filename' => 'Nama_berkas',
'Operations' => 'Operasi',
'Date_type' => 'y-m-d',
'OK' => 'OK',
'Cancel' => 'Cancel',
'Sorting' => 'Sortir',
'Show_url' => 'lihat URL',
'Extract' => 'extract disini',
'File_info' => 'info berkas',
'Edit_image' => 'edit gambar',
'Duplicate' => 'Duplikat',
'Folders' => 'Folders',
'Copy' => 'Copy',
'Cut' => 'Cut',
'Paste' => 'Paste',
'CB' => 'CB',
// clipboard
'Paste_Here' => 'Paste to this directory',
'Paste_Confirm' => 'Are you sure you want to paste to this directory? This will overwrite existing files/folders if encountered any.',
'Paste_Failed' => 'Failed to paste file(s)',
'Clear_Clipboard' => 'Clear clipboard',
'Clear_Clipboard_Confirm' => 'Are you sure you want to clear the clipboard?',
'Files_ON_Clipboard' => 'There are files on the clipboard.',
'Copy_Cut_Size_Limit' => 'The selected files/folders are too big to %s. Limit: %d MB/operation',
// %s = cut or copy
'Copy_Cut_Count_Limit' => 'You selected too many files/folders to %s. Limit: %d files/operation',
// %s = cut or copy
'Copy_Cut_Not_Allowed' => 'You are not allowed to %s files.',
// %s(1) = cut or copy, %s(2) = files or folders
'Image_Editor_No_Save' => 'Could not save image',
'Image_Editor_Exit' => "Exit",
'Image_Editor_Save' => "Save",
'Zip_No_Extract' => 'Could not extract. File might be corrupt.',
'Zip_Invalid' => 'This extension is not supported. Valid: zip, gz, tar.',
'Dir_No_Write' => 'The directory you selected is not writable.',
'Function_Disabled' => 'The %s function has been disabled by the server.',
// %s = cut or copy
'File_Permission' => 'File permission',
'File_Permission_Not_Allowed' => 'Changing %s permissions are not allowed.',
// %s = files or folders
'File_Permission_Recursive' => 'Apply recursively?',
'File_Permission_Wrong_Mode' => "The supplied permission mode is incorrect.",
'User' => 'User',
'Group' => 'Group',
'Yes' => 'Yes',
'No' => 'No',
'Lang_Not_Found' => 'Could not find language.',
'Lang_Change' => 'Change the language',
'File_Not_Found' => 'Could not find the file.',
'File_Open_Edit_Not_Allowed' => 'You are not allowed to %s this file.',
// %s = open or edit
'Edit' => 'Edit',
'Edit_File' => "Edit file's content",
'File_Save_OK' => "File successfully saved.",
'File_Save_Error' => "There was an error while saving the file.",
'New_File' => 'New File',
'No_Extension' => 'You have to add a file extension.',
'Valid_Extensions' => 'Valid extensions: %s',
// %s = txt,log etc.
'Upload_message' => "Drop file here to upload",
'SERVER ERROR' => "SERVER ERROR",
'forbidden' => "Forbiden",
'wrong path' => "Wrong path",
'wrong name' => "Wrong name",
'wrong extension' => "Wrong extension",
'wrong option' => "Wrong option",
'wrong data' => "Wrong data",
'wrong action' => "Wrong action",
'wrong sub-action' => "Wrong sub-actio",
'no action passed' => "No action passed",
'no path' => "No path",
'no file' => "No file",
'view type number missing' => "View type number missing",
'Not enough Memory' => "Not enough Memory",
'max_size_reached' => "Your image folder has reach its maximale size of %d MB.",
//%d = max overall size
'B' => "B",
'KB' => "KB",
'MB' => "MB",
'GB' => "GB",
'TB' => "TB",
'total size' => "Total size",
];
```
|
```xml
import React, { useEffect } from 'react'
import { createEditor, Text, Transforms } from 'slate'
import { act, render } from '@testing-library/react'
import { Slate, withReact, Editable } from '../src'
describe('slate-react', () => {
describe('Editable', () => {
describe('NODE_TO_KEY logic', () => {
test('should not unmount the node that gets split on a split_node operation', async () => {
const editor = withReact(createEditor())
const initialValue = [{ type: 'block', children: [{ text: 'test' }] }]
const mounts = jest.fn()
act(() => {
render(
<Slate
editor={editor}
initialValue={initialValue}
onChange={() => {}}
>
<Editable
renderElement={({ children }) => {
useEffect(() => mounts(), [])
return children
}}
/>
</Slate>
)
})
// slate updates at next tick, so we need this to be async
await act(async () =>
Transforms.splitNodes(editor, { at: { path: [0, 0], offset: 2 } })
)
// 2 renders, one for the main element and one for the split element
expect(mounts).toHaveBeenCalledTimes(2)
})
test('should not unmount the node that gets merged into on a merge_node operation', async () => {
const editor = withReact(createEditor())
const initialValue = [
{ type: 'block', children: [{ text: 'te' }] },
{ type: 'block', children: [{ text: 'st' }] },
]
const mounts = jest.fn()
act(() => {
render(
<Slate
editor={editor}
initialValue={initialValue}
onChange={() => {}}
>
<Editable
renderElement={({ children }) => {
useEffect(() => mounts(), [])
return children
}}
/>
</Slate>
)
})
// slate updates at next tick, so we need this to be async
await act(async () =>
Transforms.mergeNodes(editor, { at: { path: [0, 0], offset: 0 } })
)
// only 2 renders for the initial render
expect(mounts).toHaveBeenCalledTimes(2)
})
})
test('calls onSelectionChange when editor select change', async () => {
const editor = withReact(createEditor())
const initialValue = [
{ type: 'block', children: [{ text: 'te' }] },
{ type: 'block', children: [{ text: 'st' }] },
]
const onChange = jest.fn()
const onValueChange = jest.fn()
const onSelectionChange = jest.fn()
act(() => {
render(
<Slate
editor={editor}
initialValue={initialValue}
onChange={onChange}
onValueChange={onValueChange}
onSelectionChange={onSelectionChange}
>
<Editable />
</Slate>
)
})
await act(async () =>
Transforms.select(editor, { path: [0, 0], offset: 2 })
)
expect(onSelectionChange).toHaveBeenCalled()
expect(onChange).toHaveBeenCalled()
expect(onValueChange).not.toHaveBeenCalled()
})
test('calls onValueChange when editor children change', async () => {
const editor = withReact(createEditor())
const initialValue = [{ type: 'block', children: [{ text: 'test' }] }]
const onChange = jest.fn()
const onValueChange = jest.fn()
const onSelectionChange = jest.fn()
act(() => {
render(
<Slate
editor={editor}
initialValue={initialValue}
onChange={onChange}
onValueChange={onValueChange}
onSelectionChange={onSelectionChange}
>
<Editable />
</Slate>
)
})
await act(async () => Transforms.insertText(editor, 'Hello word!'))
expect(onValueChange).toHaveBeenCalled()
expect(onChange).toHaveBeenCalled()
expect(onSelectionChange).not.toHaveBeenCalled()
})
test('calls onValueChange when editor setNodes', async () => {
const editor = withReact(createEditor())
const initialValue = [{ type: 'block', children: [{ text: 'test' }] }]
const onChange = jest.fn()
const onValueChange = jest.fn()
const onSelectionChange = jest.fn()
act(() => {
render(
<Slate
editor={editor}
initialValue={initialValue}
onChange={onChange}
onValueChange={onValueChange}
onSelectionChange={onSelectionChange}
>
<Editable />
</Slate>
)
})
await act(async () =>
Transforms.setNodes(
editor,
// @ts-ignore
{ bold: true },
{
at: { path: [0, 0], offset: 2 },
match: Text.isText,
split: true,
}
)
)
expect(onChange).toHaveBeenCalled()
expect(onValueChange).toHaveBeenCalled()
expect(onSelectionChange).not.toHaveBeenCalled()
})
test('calls onValueChange when editor children change', async () => {
const editor = withReact(createEditor())
const initialValue = [{ type: 'block', children: [{ text: 'test' }] }]
const onChange = jest.fn()
const onValueChange = jest.fn()
const onSelectionChange = jest.fn()
act(() => {
render(
<Slate
editor={editor}
initialValue={initialValue}
onChange={onChange}
onValueChange={onValueChange}
onSelectionChange={onSelectionChange}
>
<Editable />
</Slate>
)
})
await act(async () => Transforms.insertText(editor, 'Hello word!'))
expect(onValueChange).toHaveBeenCalled()
expect(onChange).toHaveBeenCalled()
expect(onSelectionChange).not.toHaveBeenCalled()
})
})
})
```
|
```javascript
/*
*
*/
import jsdom from "jsdom";
import { configure } from "enzyme";
import Adapter from "@wojtekmaj/enzyme-adapter-react-17";
const { JSDOM } = jsdom;
const dom = new JSDOM("<!doctype html><html><body></body></html>");
global.document = dom.window.document;
global.window = dom.window;
global.self = global;
global.performance = {};
configure({ adapter: new Adapter() });
const node = {
getAttribute: arg => true,
parentNode: null
};
window.getSelection = () => ({
rangeCount: 1,
getRangeAt: index => ({ startContainer: [node] })
});
```
|
Thayer Street in Providence, Rhode Island is a popular destination for students of the area's nearby schools of Brown University, Moses Brown School, Hope High School, Wheeler School, Rhode Island School of Design, Providence College, Johnson & Wales University, and Rhode Island College.
History
Thayer was initially designated in 1799 as Cross Street. In 1823, the street's name was changed to Thayer after Dr. Williams Thayer, great-great-grandson of Roger Williams. It was once the home to the Thayer Street Grammar School (built in 1866–1867), located at the corner of Thayer and Meeting streets.
Neighborhood information
Thayer Street is located in the College Hill neighborhood on the East Side of Providence. Some Brown University student housing and academic buildings are on Thayer Street.
Similar to Harvard Square in Cambridge, Massachusetts, Nassau Street in Princeton, New Jersey, and Telegraph Avenue in Berkeley, California, Thayer Street hosts independent shops and restaurants that serve as a communal center for students and locals. While Harvard Square has long been dominated by chain restaurants and stores, many businesses on Thayer remain independent, such as Avon Cinema.
Starting in the mid-2000s, there has been a general increase in the proportion of Thayer Street businesses that serve food. Neighborhood residents and some other community members argue that landlords should try to lease space to retail stores instead of new restaurants. This preference is due in part to the limited parking currently available on College Hill. City zoning regulations require far fewer off-street parking spaces for retail businesses than for restaurants. Residents also complain of noise late at night and the College Hill Neighborhood Association, an organization representing College Hill residents, generally fights against applications for liquor licenses on Thayer Street.
Images
References
External links
Thayer Street at Art in Ruins
Brown University
Geography of Providence, Rhode Island
Roads in Rhode Island
|
INS Jyoti (A58) (meaning: sacred light) is the third of the four Komandarm Fedko-class replenishment oilers. She was modified for naval use and is now being operated by the Eastern Naval Command of the Indian Navy. Jyoti was the largest ship in the navy until INS Vikramaditya (R33) was commissioned in November 2013. Its primary role is fleet replenishment and sustaining blue-water operations. It was later fitted with close-in weapon systems for self-defence.
It is a major force multiplier in sustaining the navy's blue water operations. It can increase the range of a naval task force without tanker support from seven days and 2400 nautical miles to 50 days and 16,800 nautical miles.
Design and description
General characteristics and propulsion
INS Jyoti has a length of overall, a beam of and a draft of . The ships displaces about at full load. The complement is about 208, including 23 officers.
The ship is powered by a Bryansk–Burmeister & Wain 6DKRN60/195 diesel (a licence-built MAN-B&W 6L60MC) delivering to a single fixed pitch propeller. This allows the ship to reach a maximum speed of for an endurance of
Capacity
Displacing 39,900 tons at full load, Jyoti is the second largest ship of the navy, even larger than the decommissioned 28,500 tons aircraft carrier INS Viraat. The ship can carry 28,000 tons at full load, consisting of fuel diesel, aviation fuels, oils, and water of different grades. The fresh water carried for use in steam turbines is of much higher grade than drinking water.
Jyoti has two replenishment positions on each side, with the option of stern refueling and can replenish three ships simultaneously. It can refuel at the rate of 300 tonnes per hour. It has a range of 12,000 nautical miles at the top speed of 15 knots. It has a double-skin hull, which prevents sea pollution in case of damage to any fuel tank, and carries eco-friendly equipment on board to prevent marine and environmental pollution. The space between the double-hull is used for ballast tanks. The fuel and water levels in the cargo tanks are checked to maintain the ship's stability during loading and discharging of supplies.
Armament
It was initially armed with light and medium machine guns. In 2000, self-defence capability was added by installing new close-in weapons like anti-aircraft and anti-missile guns and missiles. This was done to enhance the survivability of the ship during surface warfare operations on India's western seaboard. It also has a helicopter deck.
Procurement and service
INS Jyoti was constructed by the Admiralty Shipyard of St. Petersburg, Russia. It was built to be a Project 15966M merchant tanker, but was modified and purchased by the Indian Navy, and was commissioned on 20 July 1996.
Service history
1998
Growth in the India-Philippines relations broadened ways for the cooperation between navies. Three Indian naval ships - , and INS Jyoti visited the Philippines from 24–27 October 1998.
On 28 March 1998, four civilian workmen were killed in a gas explosion on-board Jyoti at the naval dockyard.
2001
INS Jyoti and were deployed to South East Asia and South West Pacific. The ships made port calls at Fremantle, Sydney, Wellington and Ho Chi Minh City.
2003
INS Jyoti visited the Shanghai naval base in 2003 as part of a three-vessel fleet, for a five-day official visit. The fleet was commanded by flag officer Rear Admiral R. P. Suthan of India's Eastern Naval Command. It comprised a guided missile destroyer , a guided missile corvette and Jyoti. The fleet held airborne and surface search and rescue exercises with China's East Sea Fleet, which were code-named Dolphin 0311. Before the joint exercise, the Chinese and Indian ships also conducted maritime communication and formation maneuvers. These were the first joint naval exercises between China and India. The fleet left Shanghai on 14 November 2003.
2007
In early 2007, a fleet of ships from the navy's Eastern command conducted a two-month-long deployment in the South-East and East Asia. The ships, guided-missile destroyers , INS Rana and INS Ranjit, the guided-missile corvette, INS Kuthar and the fleet tanker INS Jyoti, were under the command of Flag Officer Commanding Eastern Fleet, Rear Admiral R K Dhowan. From 18 March to 23 May, the fleet made port-calls at a number of ports, including Singapore, Yokosuka in Japan, Qingdao located on the southern coast of the Shandong peninsula of China, Ho Chi Minh City in Vietnam, and Vladivostok in Russia. The fleet left Qingdao on 16 April 2007, and then conducted joint anti-terror exercises with the Russian Navy.
During September 2007, the navy deployed three ships - , INS Beas and INS Jyoti on a four-day goodwill mission to Oman, to strengthen maritime relations and develop maritime cooperation. The deployment was led by Rear Admiral Shekhar Sinha, Flag Officer Commanding of Western Naval Command.
2009
In 2009, Jyoti, along with INS Mumbai, INS Ranvir and INS Khanjar took part in an international fleet review at Qingdao, conducted by the China's People's Liberation Army Navy (PLAN) on its 60th anniversary. Twenty one naval vessels from 14 nations and delegations from 29 countries took part in the review, which lasted from 20 to 24 April. The fleet then proceeded to Okinawa in Japan, and took part in Malabar 2010 with the US Navy's Seventh fleet and the Japanese Maritime Self-Defense Force. The other ships were , guided missile destroyers and , fast-attack submarine of the US Navy, and two guided-missile destroyers, including of the JMSDF, along with various P-3C and SH-60 aircraft. The exercise involved air defence, anti-submarine and surface warfare.
2010
By 2010, the ship had completed thirteen years in the navy, during which it had undertaken 2504 underway replenishment runs and travelled 375,282 nautical miles. It had operated in the Indian Ocean, South China Sea, Red Sea, Persian Gulf and the Pacific Ocean and has participated in numerous multinational exercises with the navies of United States of America, South Korea, Philippines, Japan and Singapore etc.
In April 2010, it took part in the 17th Singapore-Indian Maritime Bilateral Exercise (SIMBEX) with the Singapore Navy. SIMBEX-2010 was held in the Andaman Sea and the Bay of Bengal. Five platforms of the Indian Navy took part, , a fast-attack craft and , a landing ship tank from the Andaman & Nicobar Command, destroyer , the tanker INS Jyoti and a submarine from the Eastern Naval Command. Singapore Navy was represented by two ships, , a Formidable-class frigate and , a Victory-class corvette. During the exercise, Jyoti simultaneously refueled INS Ranvir and RSS Intrepid. The fleet later called at Port Blair and Visakhapatnam.
In May 2010, the navy’s Eastern Fleet deployed INS Jyoti, along with guided-missile destroyers INS Rana and INS Ranjit and missile corvette INS Kulish from Port Blair to South East Asia, where the fleet undertook passage exercises with the navies of Indonesia, Singapore and Australia. Jyoti was under the command of Captain A Venugopal NM and carried a complement of 19 officers and 170 sailors. The fleet sailed under the command of Flag Officer Commanding, Eastern Fleet, Rear Admiral P N Murugesan and made port calls at Jakarta (Indonesia), Hai Phong (Vietnam), Manila (Philippines), Muara (Brunei), Bangkok (Thailand), Fremantle (Australia), Singapore and Port Kelang (Malaysia). At Port Kelang, the fleet conducted anti-piracy exercises with the Malaysian Navy from 20 to 23 June, and left port on 23 June.
2011
In early 2011, the ship was part of a fleet of warships from the Eastern Fleet which went on an operational deployment in South East Asia and Western Pacific. The flotilla was composed of , INS Ranvijay, INS Ranvir, INS Jyoti and INS Kirch, and carried 1,400 naval personnel on board. They were commanded by Rear Admiral Harish Chandra Singh Bisht. The flotilla, along with an Indian Navy maritime reconnaissance aircraft took part in a five-day exercise SIMBEX 2011 with the Singapore navy in the South China Sea. Four naval ships including a submarine of the Singapore Navy were commanded by Rear Admiral Joseph Leong, Fleet Commander of the Republic of Singapore Navy. The Indian fleet then proceeded on its forward deployment, and made port calls at Alava pier in Subic Bay (Philippines), Vlapostok (Russia), Manila (Philippines), Ho Chi Minh City (Vietnam), Bandar Sera Begawan (Brunei), Kota Kina Balu (Malaysia) and Jakarta (Indonesia). The ships also visited China, Japan and South Korea. After exercising with the U.S. Navy, the fleet conducted drills at Vladivostok, with the Russian Navy's Pacific Fleet. This was the second time the Indian Navy had made a port call at Vladivostok.
From 2–10 April, the ship, as part of the flotilla took part in the Malabar 2011 exercise with the U.S. Navy's 7th Fleet.
In May 2011, Jyoti and Ranvir, led by Captain Sunil Balakrishnan, were deployed to Brunei, and docked at Muara port. The purpose of the visit was to build on cultural and diplomatic relations between the two countries.
See also
References
External links
INS Jyoti refueling two frigates at sea during SIMBEX 2011
INS Jyoti in Malabar 2011
The tanker INS Jyoti
1995 ships
Tankers of the Indian Navy
|
```ruby
# frozen_string_literal: true
class AddScopesToInitiativesVotes < ActiveRecord::Migration[5.2]
class InitiativeVote < ApplicationRecord
self.table_name = :decidim_initiatives_votes
belongs_to :initiative, foreign_key: "decidim_initiative_id", class_name: "Initiative"
end
class Initiative < ApplicationRecord
self.table_name = :decidim_initiatives
belongs_to :scoped_type, class_name: "InitiativesTypeScope"
end
class InitiativesTypeScope < ApplicationRecord
self.table_name = :decidim_initiatives_type_scopes
end
def change
add_column :decidim_initiatives_votes, :decidim_scope_id, :integer
InitiativeVote.reset_column_information
InitiativeVote.includes(initiative: :scoped_type).find_each do |vote|
vote.decidim_scope_id = vote.initiative.scoped_type.decidim_scopes_id
vote.save!
end
end
end
```
|
```javascript
/**
* @license Apache-2.0
*
*
*
* path_to_url
*
* Unless required by applicable law or agreed to in writing, software
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*/
'use strict';
// MODULES //
var logger = require( 'debug' );
// MAIN //
var debug = logger( 'random:streams:geometric' );
// EXPORTS //
module.exports = debug;
```
|
St. Elizabeth High School may refer to:
St. Elizabeth High School (Oakland, California) — Oakland, California
St. Elizabeth High School (Wilmington, Delaware) — Wilmington, Delaware
St. Elizabeth Catholic High School
St. Elizabeth Secondary School — Karen, Nairobi
St. Elizabeth Secondary School, Sibu, Sarawak
|
The name Vance has been used for three tropical cyclones worldwide, twice in the Eastern Pacific and once in the Australian Region of the South Pacific.
In the Eastern Pacific:
Hurricane Vance (1990) – never approached land.
Hurricane Vance (2014) – a Category 2 hurricane that affected Mexico
In the Australian Region:
Cyclone Vance (1999) – caused extensive damage in Western Australia
Pacific hurricane set index articles
Australian region cyclone set index articles
|
```xml
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="path_to_url"
xmlns:app="path_to_url"
android:orientation="vertical"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:background="#232a30"
android:gravity="center_horizontal">
<moe.codeest.enviews.ENRefreshView
android:id="@+id/view_refresh"
android:layout_width="80dp"
android:layout_height="80dp"
android:layout_marginTop="20dp"
app:refresh_line_color="#ffffff"
app:refresh_line_width="14"/>
<Button
android:id="@+id/btn_refresh"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginTop="20dp"
android:text="startRefresh"/>
</LinearLayout>
```
|
Anchicremna is a genus of moths belonging to the subfamily Tortricinae of the family Tortricidae.
Species
Anchicremna eulidias Meyrick, 1926
Anchicremna uncinata Razowski & Wojtusiak, 2010
See also
List of Tortricidae genera
References
, 1926: Exotic Microlepidoptera. Exotic Microlepidoptera 3(8): 225-256.
, 2010: Tortricidae (Lepidoptera) from Peru. Acta Zoologica Cracoviensia 53B (1-2): 73-159. . Full article: .
External links
tortricidae.com
Sparganothini
Tortricidae genera
|
```xml
import React from "react";
import { Rnd } from "../../src";
import { style } from "../styles";
export default () => (
<Rnd
style={style}
default={{
width: 200,
height: 200,
x: 0,
y: 0,
}}
dragGrid={[20, 30]}
>
001
</Rnd>
);
```
|
```xml
import { FluentDesignSystem } from '../fluent-design-system.js';
import { definition } from './text-input.definition.js';
definition.define(FluentDesignSystem.registry);
```
|
```objective-c
//
// YFToDoWireframe.m
// BigShow1949
//
// Created by big show on 2018/12/8.
//
#import "YFToDoWireframe.h"
@implementation YFToDoWireframe
- (void)pushViewController:(UIViewController *)destination fromViewController:(UIViewController *)source {
[source.navigationController pushViewController:destination animated:YES];
}
- (void)presentListInterfaceFromVC:(UIViewController *)vc {
}
@end
```
|
```javascript
/**
* @license
*/
import {createRequire} from 'module';
import url from 'url';
import path from 'path';
/**
* Commonjs equivalent of `require.resolve`.
* @param {string} packageName
*/
function resolveModulePath(packageName) {
const require = createRequire(import.meta.url);
return require.resolve(packageName);
}
/**
* @param {ImportMeta} importMeta
*/
function getModulePath(importMeta) {
return url.fileURLToPath(importMeta.url);
}
/**
* @param {ImportMeta} importMeta
*/
function getModuleDirectory(importMeta) {
return path.dirname(getModulePath(importMeta));
}
export {
resolveModulePath,
getModulePath,
getModuleDirectory,
};
```
|
Mordellistena nessebaricus is a species of beetle in the genus Mordellistena of the family Mordellidae. It was described by Batten in 1980.
References
Beetles described in 1980
nessebaricus
|
```scala
/*
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
*
* path_to_url
*
* Unless required by applicable law or agreed to in writing, software
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*/
package org.apache.spark.sql
import org.apache.spark.sql.catalyst.TableIdentifier
import org.apache.spark.sql.catalyst.expressions.{Attribute, EmptyRow, Expression}
import org.apache.spark.sql.execution.FileSourceScanExec
import org.apache.spark.sql.execution.datasources.HadoopFsRelation
import org.apache.spark.sql.types.StructType
object SparkSqlAdapter {
def initSparkSQL(): Unit = {
}
def getScanForSegments(
@transient relation: HadoopFsRelation,
output: Seq[Attribute],
outputSchema: StructType,
partitionFilters: Seq[Expression],
dataFilters: Seq[Expression],
tableIdentifier: Option[TableIdentifier]
): FileSourceScanExec = {
FileSourceScanExec(
relation,
output,
outputSchema,
partitionFilters,
None,
None,
dataFilters,
tableIdentifier)
}
}
```
|
Portsmouth is a city in Rockingham County, New Hampshire, United States. At the 2020 census it had a population of 21,956. A historic seaport and popular summer tourist destination on the Piscataqua River bordering the state of Maine, Portsmouth was formerly the home of the Strategic Air Command's Pease Air Force Base, since converted to Portsmouth International Airport at Pease.
History
American Indians of the Abenaki and other Algonquian languages-speaking nations, and their predecessors, inhabited the territory of coastal New Hampshire for thousands of years before European contact.
The first known European to explore and write about the area was Martin Pring in 1603. The Piscataqua River is a tidal estuary with a swift current, but forms a good natural harbor. The west bank of the harbor was settled by European colonists in 1630 and named Strawbery Banke, after the many wild strawberries growing there. The village was protected by Fort William and Mary on what is now New Castle Island. Strategically located for trade between upstream industries and mercantile interests abroad, the port prospered. Fishing, lumber and shipbuilding were principal businesses of the region. Enslaved Africans were imported as laborers as early as 1645 and were integral to building the city's prosperity. Portsmouth was part of the Triangle Trade, which made significant profits from slavery.
At the town's incorporation in 1653, it was named "Portsmouth" in honor of the colony's founder, John Mason. He had been captain of the English port of Portsmouth, Hampshire, after which New Hampshire is named.
When Queen Anne's War ended in 1712, Governor Joseph Dudley selected the town to host negotiations for the 1713 Treaty of Portsmouth, which temporarily ended hostilities between the Abenaki Indians and the colonies of Massachusetts Bay and New Hampshire.
In 1774, in the lead-up to the Revolution, Paul Revere rode to Portsmouth warning that the British Royal Navy was coming to capture the port. Although Fort William and Mary protected the harbor, the Patriot government moved the capital inland to Exeter, which ensured that it would be under no threat from the Royal Navy, which bombarded Falmouth (now Portland, Maine) instead on October 18, 1775. Portsmouth was the destination for several of Beaumarchais's ships containing materiel, such as artillery, tents, and gunpowder, to help the American revolutionary effort. African Americans helped defend Portsmouth and New England during the war. In 1779, 19 enslaved African Americans from Portsmouth wrote a petition to the state legislature and asked that it abolish slavery, in recognition of their war contributions and in keeping with the principles of the Revolution. The legislature tabled their petition. New Hampshire abolished slavery in 1857, by which time the institution was effectively extinct in the state.
Thomas Jefferson's 1807 embargo against American trade with Britain severely disrupted New England's trade with Canada, and several local businessmen went bankrupt. Portsmouth was host to numerous privateers during the War of 1812. In 1849, Portsmouth was incorporated as a city.
Once one of the nation's busiest ports and shipbuilding cities, Portsmouth expressed its wealth in fine architecture. It has significant examples of Colonial, Georgian, and Federal style houses, some of which are now museums. Portsmouth's heart has stately brick Federalist stores and townhouses, built all-of-a-piece after devastating early 19th-century fires. The worst was in 1813 when 244 buildings burned. A fire district was created that required all new buildings within its boundaries to be built of brick with slate roofs; this created the downtown's distinctive appearance. The city was also noted for the production of boldly wood-veneered federal-style (neoclassical) furniture, particularly by the master cabinet maker Langley Boardman.
The Industrial Revolution spurred economic growth in New Hampshire mill towns such as Dover, Keene, Laconia, Manchester, Nashua and Rochester, where rivers provided water power for the mills. It shifted growth to the new mill towns. The port of Portsmouth declined, but the city survived Victorian-era doldrums, a time described in the works of Thomas Bailey Aldrich, particularly in his 1869 novel The Story of a Bad Boy.
In the 20th century, the city founded a Historic District Commission, which has worked to protect much of the city's irreplaceable architectural legacy. In 2008, the National Trust for Historic Preservation named Portsmouth one of the "Dozen Distinctive Destinations". The compact and walkable downtown on the waterfront draws tourists and artists, who each summer throng the cafes, restaurants and shops around Market Square. Portsmouth annually celebrates the revitalization of its downtown (in particular Market Square) with Market Square Day, a celebration dating back to 1977, produced by the non-profit Pro Portsmouth, Inc.
This emphasis on historic preservation and revitalization was the result of much pain and destruction. Portsmouth is largely walkable due to its network of streets and tight blocks filled with preserved Revolution-era homes. However, like many other cities all over the region (and nation), Portsmouth was hit by Urban Renewal, a planning tool used nationwide to provide Federal funds to address “urban blight” and revitalize downtown cores after decades of suburbanization and loss of tax revenue. An urban renewal district for Portsmouth was its North End neighborhood, which similar to Boston’s, was home to an Italian-American population.
In 1964, federal funds were allocated to the North End project area in Portsmouth, for urban renewal. Prior to redevelopment, the North End was a mix of residential and commercial buildings, with many older houses converted into storefronts with apartments above. In the mid-1960s, the area was considered overcrowded, run down, and a fire hazard. As a result, the Portsmouth Housing Authority proposed the destruction of approximately 200 buildings, a school, and a church and redevelopment for commercial, industrial, and public use, rather than for residences. The project would displace approximately 300 families as a result. In 1968, Portsmouth Preservation Inc., a preservation organization was formed to attempt to save some of the historic building stock in the area slated for redevelopment. After bitter fighting and preservation advocacy, just fourteen houses were saved and mostly moved to an area known today as “The Hill”. This preservation was only the beginning, and eventually efforts conspired to created the afformentioned historic district. Urban renewal was many events that led to its creation.
Portsmouth shipbuilding history has had a long symbiotic relationship with Kittery, Maine, across the Piscataqua River. In 1781–1782, the naval hero John Paul Jones lived in Portsmouth while he supervised construction of his ship Ranger, which was built on nearby Badger's Island in Kittery. During that time, he boarded at the Captain Gregory Purcell house, which now bears Jones' name, as it is the only surviving property in the United States associated with him. Built by the master housewright Hopestill Cheswell, an African American, it has been designated as a National Historic Landmark. It now serves as the Portsmouth Historical Society Museum.
The Portsmouth Naval Shipyard, established in 1800 as the first federal navy yard, is on Seavey's Island in Kittery, Maine. The base is famous for being the site of the 1905 signing of the Treaty of Portsmouth which ended the Russo-Japanese War. Though US President Theodore Roosevelt orchestrated the peace conference that brought Russian and Japanese diplomats to Portsmouth and the Shipyard, he never came to Portsmouth, relying on the Navy and people of New Hampshire as the hosts. Roosevelt won the 1906 Nobel Peace Prize for his diplomacy in bringing about an end to the war.
Geography
According to the United States Census Bureau, the city has a total area of , of which are land and , or 6.92%, are water. Portsmouth is drained by Berrys Brook, Sagamore Creek and the Piscataqua River, which is the boundary between New Hampshire and Maine. The highest point in the city is above sea level, within Pease International Airport.
Climate
Portsmouth has a humid continental climate (Dfb) in spite of its maritime position, due to prevailing inland winds. Summers are moderately warm with winter days averaging around the freezing point, but with cold nights bringing it below the required isotherm to have a humid continental climate. With high year-round precipitation, the cold winters can often be very snowy and summers wet.
Demographics
Portsmouth is the sole city in Rockingham County, but the fourth-largest municipality, with fewer people than the towns of Derry, Londonderry, and Salem.
As of the census of 2010, there were 21,233 people, 10,014 households, and 4,736 families residing in the city. The population density was . There were 10,625 housing units at an average density of . The racial makeup of the city was 91.5% White, 1.7% African American, 0.2% Native American, 3.5% Asian, 0.01% Pacific Islander, 0.7% some other race, and 2.3% from two or more races. Hispanic or Latino of any race were 2.8% of the population.
There were 10,014 households, out of which 20.2% had children under the age of 18 living with them, 35.5% were headed by married couples living together, 8.3% had a female householder with no husband present, and 52.7% were non-families. 39.2% of all households were made up of individuals, and 11.8% were someone living alone who was 65 years of age or older. The average household size was 2.03, and the average family size was 2.75.
In the city, the population was spread out, with 16.6% under the age of 18, 7.7% from 18 to 24, 32.2% from 25 to 44, 27.6% from 45 to 64, and 15.9% who were 65 years of age or older. The median age was 40.3 years. For every 100 females, there were 94.2 males. For every 100 females age 18 and over, there were 92.6 males.
For the period 2010–2014, the city's estimated median annual household income was $67,679, and the median family income was $90,208. Male full-time workers had a median income of $58,441 versus $45,683 for females. The city's per capita income for the city was $42,724. About 4.0% of families and 7.6% of the population were below the poverty line, including 6.9% of those under age 18 and 7.1% of those age 65 or over.
Economy
Heinemann USA is based in Portsmouth. Before its dissolution, Boston-Maine Airways (Pan Am Clipper Connection), a regional airline, was also headquartered in Portsmouth.
Companies with headquarters in Portsmouth include packaged software producer Bottomline Technologies and frozen yogurt maker Sweet Scoops.
Top employers
According to the city's 2020 Comprehensive Annual Financial Report, the top ten employers in the city are:
Arts and culture
The Portsmouth Downtown Historic District encompasses the city's historic urban core and Market Square.
Sites of interest
USS Albacore Museum & Park – a museum featuring the USS Albacore, a U.S. Navy submarine used for testing, which was decommissioned in 1972 and moved to the park in 1985. The submarine is open for tours.
Buckminster House – built in 1725, formerly a funeral parlor.
Green Elephant Vegetarian Bistro – Thai restaurant at 35 Portwalk Place opened in 2015.
Cabot Lyford four public sculptures – including "The Whale" and "My Mother the Wind," a seven-ton blank granite statue which was installed on Portsmouth's waterfront in 1975.
The Music Hall – a 900-seat theater opened in 1878.
New Hampshire Theatre Project – founded in 1986, a non-profit theater organization producing contemporary and classical works, and offering educational programs.
North Church – historic church, the steeple of which is visible from most of Portsmouth
The Player's Ring Theater – a black-box theater that produces original work from local playwrights.
Pontine Theatre – produces original theater works based on the history, culture and literature of New England at their 50-seat black box venue.
Portsmouth African Burying Ground – a memorial park and the only archeologically verified 18th-century African burying ground in New England.
Portsmouth Athenæum – a private membership library, museum and art gallery open to the public at certain times.
Portsmouth Harbor Lighthouse – first established in 1771, the current structure was built in 1878 and is open for monthly tours from May through September.
Portsmouth Historical Society – founded in 1917, includes museum galleries, a gift shop, welcome center, walking tours, and operates the John Paul Jones House.
Prescott Park Arts Festival – summer entertainments in Portsmouth's waterfront park since 1974.
Rockingham Hotel and the Library Restaurant – historic former hotel and contemporary restaurant. Built in 1885, it is a prominent early example of Colonial Revival architecture.
Seacoast Repertory Theatre – founded in 1988, a professional theater troupe.
Strawbery Banke Museum – a neighborhood featuring several dozen restored historic homes in Colonial, Georgian and Federal styles of architecture. The site of one of Portsmouth's earliest settlements.
Whaling Wall – Painting of Isles of Shoals Humpbacks created by Robert Wyland, situated on the back of Cabot House Furniture. It is in disrepair, and restoration has not been allowed by the owners of Cabot Furniture.
Historic house museums
Richard Jackson House (1664)
John Paul Jones House (1758)
Governor John Langdon House (1784)
Tobias Lear House (1740)
Moffatt-Ladd House (also called William Whipple House) (1763)
Rundlet-May House (1807)
MacPheadris-Warner House (1716)
Wentworth-Coolidge Mansion (1750)
Wentworth-Gardner House (also called Wentworth House) (1760)
Henry Sherburne House (1766)
Sports
The Seacoast United Phantoms are a soccer team based in Portsmouth. Founded in 1996, the team plays in the Northeast Division of USL League Two (USL2), one of the unofficial fourth-tier leagues of the American Soccer Pyramid.
Freedom Rugby Football Club is a men's rugby union team based in Portsmouth, founded in the summer of 2014. The club is an active member of USA Rugby and New England Rugby Football Union (NERFU).
Government
The city of Portsmouth operates under a council-manager system of government. Portsmouth elects a nine-member at-large City Council to serve as the city's primary legislative body. The candidate who receives the most votes is designated the Mayor (currently Deaglan McEachern), while the candidate receiving the second-highest vote total is designated the Assistant Mayor (currently Joanna Kelley). While the mayor and council convene to establish municipal policy, the City Manager (currently Karen Conard) oversees the city's day-to-day operations.
Portsmouth is part of New Hampshire's 1st congressional district, currently represented by Democrat Chris Pappas. Portsmouth is part of the Executive Council's 3rd district, currently represented by Republican Janet Stevens. In the State Senate, Portsmouth is represented by Democrat Rebecca Perkins Kwoka. In the State House of Representatives, Portsmouth is divided among the 25th through 31st Rockingham districts.
Politically, Portsmouth is a center of liberal politics and a stronghold for the Democratic Party. Ronald Reagan was the last Republican presidential nominee to carry the city in his 1984 landslide reelection. In 2016, Portsmouth voted 67.70% for Hillary Clinton in the presidential election, 62.53% for Colin Van Ostern in the gubernatorial election, 64.48% for Maggie Hassan in the senatorial election, and 62.16% for Carol Shea-Porter in the congressional election. In 2014, Portsmouth voted 70.05% for Maggie Hassan in the gubernatorial election, 67.34% for Jeanne Shaheen in the senatorial election, and 68.34% for Carol Shea-Porter in the congressional election. In 2012, Portsmouth voted 67.56% for Barack Obama in the presidential election, 70.16% for Maggie Hassan in the gubernatorial election, and 68.50% for Carol Shea-Porter in the congressional election.
In March 2014, Portsmouth became the first municipality in New Hampshire to implement protections for city employees from discrimination on the basis of gender identity, by a 9–0 vote of the city council.
Education
Community College System of New Hampshire, Great Bay Community College – Portsmouth campus
Franklin Pierce University – Portsmouth campus
Granite State College – Portsmouth campus and on-site location at Great Bay Community College
Media
Print
The New Hampshire Gazette
The Portsmouth Herald
Radio
WSCA-LP Portsmouth Community Radio 106.1 FM
WHEB 100.3 FM rock formatted
Infrastructure
Transportation
The city is crossed by Interstate 95, U.S. Route 1, U.S. Route 4, New Hampshire Route 1A, New Hampshire Route 16, and New Hampshire Route 33. Boston is to the south, Portland, Maine, is to the northeast, and Dover, New Hampshire, is to the northwest.
The Cooperative Alliance for Seacoast Transportation (COAST) operates a publicly funded bus network in the Seacoast region of New Hampshire and neighboring Maine including service in, to and from Portsmouth. C&J is a private intercity bus carrier connecting Portsmouth with coastal New Hampshire and Boston, as well as direct service to New York City. Wildcat Transit, operated by the University of New Hampshire, provides regular bus service to the UNH campus in Durham and intermediate stops. The service is free for students, faculty and staff and $1.50 for the general public. Amtrak's Downeaster train service, is available in Dover and Durham, nearby to the northwest. Allegiant Air offers scheduled airline service from Portsmouth International Airport at Pease (PSM).
Sister cities
Portsmouth's sister cities are:
Agadir, Morocco
Carrickfergus, Northern Ireland, United Kingdom
Kitase, Ghana
Nichinan, Japan
Pärnu, Estonia
Severodvinsk, Russia
Portsmouth also has friendly relations with:
Portsmouth, England, United Kingdom
Santarcangelo di Romagna, Italy
Szolnok, Hungary
Notable people
See also
Portsmouth Public Library (New Hampshire)
2006 Little League World Series, when a team from Portsmouth advanced to the quarter-finals
USS Portsmouth, 4 ships
References
Further reading
External links
Greater Portsmouth Chamber of Commerce
Cities in New Hampshire
Cities in Rockingham County, New Hampshire
Former colonial and territorial capitals in the United States
Populated places established in 1630
Populated coastal places in New Hampshire
1630 establishments in the Thirteen Colonies
|
"Green Shirt" is a song written by new wave musician Elvis Costello and recorded by Costello with his backing band the Attractions. The song appeared on Costello's 1979 third album, Armed Forces. Lyrically inspired by the influence of the National Front and the Quisling Clinic in Wisconsin, "Green Shirt" features a vocal recorded by Costello after a "night of carousing".
"Green Shirt" was not released as a single at the time of its 1979 release, but in 1985 it saw single release to promote The Man: The Best of Elvis Costello. The single reached number 68 in Britain. Since its release, the song has been lauded by critics as one of Costello's best album tracks and has made several appearances in Costello's live setlist.
Background
"Green Shirt" was described by Elvis Costello as "a paranoid song that I wrote ... about the simplification of seductive signals, the bedroom eyes that lead to tyranny". The song was lyrically inspired by the Quisling Clinic, a building in Madison, Wisconsin that Costello reportedly saw and wrote down the name of while driving past. Costello later wrote that, while he had only ever associated the name "Quisling" with Norwegian fascist Vidkun Quisling, the combination of "Quisling" and "Clinic" had "conjured up some kind of Boys from Brazil nightmare". Costello also cited the rise of the National Front in Britain as inspiration.
The first recording of "Green Shirt" was an acoustic demo with alternate lyrics that would appear on later editions of This Year's Model. The final version of the song would ultimately appear on Costello's 1979 album Armed Forces. Costello recorded the vocals for "Green Shirt" after what he described as a "late night of carousing". This prevented him from raising his voice on the recording, much to the chagrin of producer Nick Lowe. Costello recalled,
Release and reception
"Green Shirt" was first released on Costello's 1979 album Armed Forces. The song was not released as a single at the time. In 1985, the song was released as a single to promote the compilation album The Man: The Best of Elvis Costello. The B-side was "Beyond Belief", a song from Costello's 1982 album Imperial Bedroom. The single was a moderate success in the UK, reaching number 68 on the charts. The release was accompanied by a newly created music video that featured clips from previous Elvis Costello music videos. A writer for Sounds named the release "Single of the Week" in May 1985, writing, "An obvious choice, but why fight the irresistible? ... This is classic Costello ... simple, tense, beguiling — and sublimely arranged with a marvelous drum pattern, a crescendo of string-synth and even a trumpet fanfare on the fade."
"Green Shirt" has since been praised by critics as one of Costello's best album tracks. City Pages named the song one of Costello's 30 best deep cuts, praising the "buoyant bounce underpinning some of Costello's darkest lyrics" on the track. Tony Clayton-Lea of the Irish Times described the song as one of Costello's "back-catalogue gems" and praised the "staccato backdrop" and "spooky vocal". Paul Sexton of uDiscoverMusic called the track "brooding" and named it one of the highlights of Armed Forces, while Matt LeMay of Pitchfork called the song a "near-classic" that was "hindered" by the album's "smoother production".
Live performances
"Green Shirt" has become a mainstay of Costello's live setlist in recent years. Costello performed the song live at Heatwave in 1980, a performance which Paste Magazine described as "taken at a faster clip than the ... studio recording". Jacob Pucci of The Post-Standard described a live performance of the song at the Turning Stone Resort Casino from 2016 as "energetic" and "synth-heavy". Dave Mckenna of the Washington Post recalled that Green Shirt' ... had some of the harder core fans singing along while throwing their arms skyward in deliriousness" during a 2018 concert at the DAR Constitution Hall. At a 2018 show in Vancouver, Costello sardonically described "Green Shirt" as "a song written last century".
Charts
References
Citations
Sources
Elvis Costello songs
Songs written by Elvis Costello
1979 songs
1985 singles
Song recordings produced by Nick Lowe
|
Norman Joseph Levien (1871–1967) was a New Zealand Army Officer and a foundation member of the New Zealand Army Ordnance Corps who served in Egypt, Gallipoli and Europe during the First World War.
Early life
Born in 1871, Levien attended Nelson College 1887–88. In the period 1896–1914 he was employed as a clerk in Wellington, a flaxmiller in the Manawatu and a commercial traveller based out of Auckland.
Military career
On the outbreak of the 1st World War Levien enlisted into the 3rd Auckland Regiment as a Temporary Sergeant, transferred to the Ordnance Department as the IC of Stores and Equipment and assisted in equipping the troops for overseas service.
Levien embarked with the main body, departing Wellington on 3 December 1914 on the troopship TSS Maunganui.
On arrival in Egypt, Levien was for a short period was attached to the British Ordnance department at the Citadel in Cairo for familiarisation with the ordnance systems and procedures in use at the time.
Promoted into the NZAOC as a 2nd Lieutenant on 3 April 1915, Levien was the Officer In Charge of Equipment, Small Arms and Accoutrements (SAA) and Clothing and was in a pivotal role equipping the forces in the Dardanelles. In Alexandra he established a New Zealand Ordnance Depot at No. 12 Rue de la, Porte Rosette and a warehouse at Shed 43, Alexandra Docks.
Levien embarked for the Dardanelles on 2 August 1915, where he replaced Captain Beck as the Deputy Assistant Director of Ordnance Services(DADOS) for the Australian and New Zealand Division and was promoted to Lieutenant on 6 October 1915. Redeployed to Mudros on 28 November 1915, Levien became the Chief Ordnance Officer at Sarpi camp responsible for reequipping the now depleted Australian and New Zealand Division. On the evacuation of the Dardanelles Levien returned to Alexandra for the reorganisation of the New Zealand Division for operations in France.
As the NZ Division departed for France, Levien remained in Egypt to close and adjust the Divisions stores accounts, disposed of unserviceable stores by Auction and handed over all remaining ordnance stores to the Imperial Ordnance organisation. Closing the depot he had established in Alexandra, Levien embarked for England on 10 May 1916.
Attached to the Headquarters of the NZ Division, Levien was Promoted to Captain appointed the Chief Ordnance Officer for the NZEF in the United Kingdom where he organised and established Ordnance depots at all training camps and Hospitals throughout England.
In 1917 Levien was attached to the Woolwich Arsenal and the Army Clothing Depot at Pimlico for 6 and 4 week respectively where he was taught the basics of ammunition construction and methods of accounting and issuing ordnance stores. On his return he then inaugurated new and improved systems which was approved by the NZ HQ and distributed to all commands to become the basis of future Ordnance services in the NZEF for the remainder of its existence. Promoted to Major, levien was then posted to Sling Camp.
For his services during the war, Levien was appointed a Member of the Order of the British Empire (MBE) in the 1919 New Year Honours, and promoted to Officer of the Order of the British Empire (OBE) later that year in the King's Birthday Honours.
Levien was demobilised from the NZEF in 1919 and embarked for his return to New Zealand on 3 November 1919.
After the war
Post war Levien was the manager of the Sunshine health camp for 7 years and during WW2 he was the manager of the Corrie soldiers hostel and spent time as the assistant manager of the Commercial hotel in Hamilton, Levien was also a Justice of the Peace (JP).
Levien died in 1967 at 95 years of age.
Honours and awards
Officer of the Most Excellent Order of the British Empire
Member of the Most Excellent Order of the British Empire
1914–15 Star
British War Medal (1914–1920)
Victory Medal with oak leaf
See also
New Zealand Defence Stores Department
New Zealand Army Ordnance Department
New Zealand Army Ordnance Corps
Royal New Zealand Army Ordnance Corps
External links
To the Warrior his Arms A History of the RNZAOC and its predecessors
References
1871 births
1967 deaths
New Zealand Army officers
New Zealand military personnel of World War I
New Zealand Members of the Order of the British Empire
People educated at Nelson College
British emigrants to New Zealand
|
```go
package sqs_test
import (
"bytes"
"io/ioutil"
"net/http"
"strings"
"testing"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/awserr"
"github.com/aws/aws-sdk-go/aws/request"
"github.com/aws/aws-sdk-go/awstesting/unit"
"github.com/aws/aws-sdk-go/service/sqs"
)
var svc = func() *sqs.SQS {
s := sqs.New(unit.Session, &aws.Config{
DisableParamValidation: aws.Bool(true),
})
s.Handlers.Send.Clear()
return s
}()
func TestSendMessageChecksum(t *testing.T) {
req, _ := svc.SendMessageRequest(&sqs.SendMessageInput{
MessageBody: aws.String("test"),
})
req.Handlers.Send.PushBack(func(r *request.Request) {
body := ioutil.NopCloser(bytes.NewReader([]byte("")))
r.HTTPResponse = &http.Response{StatusCode: 200, Body: body}
r.Data = &sqs.SendMessageOutput{
MD5OfMessageBody: aws.String("098f6bcd4621d373cade4e832627b4f6"),
MessageId: aws.String("12345"),
}
})
err := req.Send()
if err != nil {
t.Errorf("expect no error, got %v", err)
}
}
func TestSendMessageChecksumInvalid(t *testing.T) {
req, _ := svc.SendMessageRequest(&sqs.SendMessageInput{
MessageBody: aws.String("test"),
})
req.Handlers.Send.PushBack(func(r *request.Request) {
body := ioutil.NopCloser(bytes.NewReader([]byte("")))
r.HTTPResponse = &http.Response{StatusCode: 200, Body: body}
r.Data = &sqs.SendMessageOutput{
MD5OfMessageBody: aws.String("000"),
MessageId: aws.String("12345"),
}
})
err := req.Send()
if err == nil {
t.Fatalf("expect error, got nil")
}
if e, a := "InvalidChecksum", err.(awserr.Error).Code(); e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := err.(awserr.Error).Message(), "expected MD5 checksum '000', got '098f6bcd4621d373cade4e832627b4f6'"; !strings.Contains(a, e) {
t.Errorf("expect %v to be in %v, was not", e, a)
}
}
func TestSendMessageChecksumInvalidNoValidation(t *testing.T) {
s := sqs.New(unit.Session, &aws.Config{
DisableParamValidation: aws.Bool(true),
DisableComputeChecksums: aws.Bool(true),
})
s.Handlers.Send.Clear()
req, _ := s.SendMessageRequest(&sqs.SendMessageInput{
MessageBody: aws.String("test"),
})
req.Handlers.Send.PushBack(func(r *request.Request) {
body := ioutil.NopCloser(bytes.NewReader([]byte("")))
r.HTTPResponse = &http.Response{StatusCode: 200, Body: body}
r.Data = &sqs.SendMessageOutput{
MD5OfMessageBody: aws.String("000"),
MessageId: aws.String("12345"),
}
})
err := req.Send()
if err != nil {
t.Errorf("expect no error, got %v", err)
}
}
func TestSendMessageChecksumNoInput(t *testing.T) {
req, _ := svc.SendMessageRequest(&sqs.SendMessageInput{})
req.Handlers.Send.PushBack(func(r *request.Request) {
body := ioutil.NopCloser(bytes.NewReader([]byte("")))
r.HTTPResponse = &http.Response{StatusCode: 200, Body: body}
r.Data = &sqs.SendMessageOutput{}
})
err := req.Send()
if err == nil {
t.Fatalf("expect error, got nil")
}
if e, a := "InvalidChecksum", err.(awserr.Error).Code(); e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := err.(awserr.Error).Message(), "cannot compute checksum. missing body"; !strings.Contains(a, e) {
t.Errorf("expect %v to be in %v, was not", e, a)
}
}
func TestSendMessageChecksumNoOutput(t *testing.T) {
req, _ := svc.SendMessageRequest(&sqs.SendMessageInput{
MessageBody: aws.String("test"),
})
req.Handlers.Send.PushBack(func(r *request.Request) {
body := ioutil.NopCloser(bytes.NewReader([]byte("")))
r.HTTPResponse = &http.Response{StatusCode: 200, Body: body}
r.Data = &sqs.SendMessageOutput{}
})
err := req.Send()
if err == nil {
t.Fatalf("expect error, got nil")
}
if e, a := "InvalidChecksum", err.(awserr.Error).Code(); e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := err.(awserr.Error).Message(), "cannot verify checksum. missing response MD5"; !strings.Contains(a, e) {
t.Errorf("expect %v to be in %v, was not", e, a)
}
}
func TestRecieveMessageChecksum(t *testing.T) {
req, _ := svc.ReceiveMessageRequest(&sqs.ReceiveMessageInput{})
req.Handlers.Send.PushBack(func(r *request.Request) {
md5 := "098f6bcd4621d373cade4e832627b4f6"
body := ioutil.NopCloser(bytes.NewReader([]byte("")))
r.HTTPResponse = &http.Response{StatusCode: 200, Body: body}
r.Data = &sqs.ReceiveMessageOutput{
Messages: []*sqs.Message{
{Body: aws.String("test"), MD5OfBody: &md5},
{Body: aws.String("test"), MD5OfBody: &md5},
{Body: aws.String("test"), MD5OfBody: &md5},
{Body: aws.String("test"), MD5OfBody: &md5},
},
}
})
err := req.Send()
if err != nil {
t.Errorf("expect no error, got %v", err)
}
}
func TestRecieveMessageChecksumInvalid(t *testing.T) {
req, _ := svc.ReceiveMessageRequest(&sqs.ReceiveMessageInput{})
req.Handlers.Send.PushBack(func(r *request.Request) {
md5 := "098f6bcd4621d373cade4e832627b4f6"
body := ioutil.NopCloser(bytes.NewReader([]byte("")))
r.HTTPResponse = &http.Response{StatusCode: 200, Body: body}
r.Data = &sqs.ReceiveMessageOutput{
Messages: []*sqs.Message{
{Body: aws.String("test"), MD5OfBody: &md5},
{Body: aws.String("test"), MD5OfBody: aws.String("000"), MessageId: aws.String("123")},
{Body: aws.String("test"), MD5OfBody: aws.String("000"), MessageId: aws.String("456")},
{Body: aws.String("test"), MD5OfBody: aws.String("000")},
{Body: aws.String("test"), MD5OfBody: &md5},
},
}
})
err := req.Send()
if err == nil {
t.Fatalf("expect error, got nil")
}
if e, a := "InvalidChecksum", err.(awserr.Error).Code(); e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := err.(awserr.Error).Message(), "invalid messages: 123, 456"; !strings.Contains(a, e) {
t.Errorf("expect %v to be in %v, was not", e, a)
}
}
func TestSendMessageBatchChecksum(t *testing.T) {
req, _ := svc.SendMessageBatchRequest(&sqs.SendMessageBatchInput{
Entries: []*sqs.SendMessageBatchRequestEntry{
{Id: aws.String("1"), MessageBody: aws.String("test")},
{Id: aws.String("2"), MessageBody: aws.String("test")},
{Id: aws.String("3"), MessageBody: aws.String("test")},
{Id: aws.String("4"), MessageBody: aws.String("test")},
},
})
req.Handlers.Send.PushBack(func(r *request.Request) {
md5 := "098f6bcd4621d373cade4e832627b4f6"
body := ioutil.NopCloser(bytes.NewReader([]byte("")))
r.HTTPResponse = &http.Response{StatusCode: 200, Body: body}
r.Data = &sqs.SendMessageBatchOutput{
Successful: []*sqs.SendMessageBatchResultEntry{
{MD5OfMessageBody: &md5, MessageId: aws.String("123"), Id: aws.String("1")},
{MD5OfMessageBody: &md5, MessageId: aws.String("456"), Id: aws.String("2")},
{MD5OfMessageBody: &md5, MessageId: aws.String("789"), Id: aws.String("3")},
{MD5OfMessageBody: &md5, MessageId: aws.String("012"), Id: aws.String("4")},
},
}
})
err := req.Send()
if err != nil {
t.Errorf("expect no error, got %v", err)
}
}
func TestSendMessageBatchChecksumFailed(t *testing.T) {
req, _ := svc.SendMessageBatchRequest(&sqs.SendMessageBatchInput{
Entries: []*sqs.SendMessageBatchRequestEntry{
{Id: aws.String("1"), MessageBody: aws.String("test")},
{Id: aws.String("2"), MessageBody: aws.String("test")},
{Id: aws.String("3"), MessageBody: aws.String("test")},
{Id: aws.String("4"), MessageBody: aws.String("test")},
},
})
req.Handlers.Send.PushBack(func(r *request.Request) {
body := ioutil.NopCloser(bytes.NewReader([]byte("")))
r.HTTPResponse = &http.Response{StatusCode: 200, Body: body}
r.Data = &sqs.SendMessageBatchOutput{
Failed: []*sqs.BatchResultErrorEntry{
{
Id: aws.String("1"),
Code: aws.String("test"),
Message: aws.String("test"),
SenderFault: aws.Bool(false),
},
{
Id: aws.String("2"),
Code: aws.String("test"),
Message: aws.String("test"),
SenderFault: aws.Bool(false),
},
{
Id: aws.String("3"),
Code: aws.String("test"),
Message: aws.String("test"),
SenderFault: aws.Bool(false),
},
{
Id: aws.String("4"),
Code: aws.String("test"),
Message: aws.String("test"),
SenderFault: aws.Bool(false),
},
},
}
})
if err := req.Send(); err != nil {
t.Errorf("expect no error, got %v", err)
}
}
func TestSendMessageBatchChecksumInvalid(t *testing.T) {
req, _ := svc.SendMessageBatchRequest(&sqs.SendMessageBatchInput{
Entries: []*sqs.SendMessageBatchRequestEntry{
{Id: aws.String("1"), MessageBody: aws.String("test")},
{Id: aws.String("2"), MessageBody: aws.String("test")},
{Id: aws.String("3"), MessageBody: aws.String("test")},
{Id: aws.String("4"), MessageBody: aws.String("test")},
},
})
req.Handlers.Send.PushBack(func(r *request.Request) {
md5 := "098f6bcd4621d373cade4e832627b4f6"
body := ioutil.NopCloser(bytes.NewReader([]byte("")))
r.HTTPResponse = &http.Response{StatusCode: 200, Body: body}
r.Data = &sqs.SendMessageBatchOutput{
Successful: []*sqs.SendMessageBatchResultEntry{
{MD5OfMessageBody: &md5, MessageId: aws.String("123"), Id: aws.String("1")},
{MD5OfMessageBody: aws.String("000"), MessageId: aws.String("456"), Id: aws.String("2")},
{MD5OfMessageBody: aws.String("000"), MessageId: aws.String("789"), Id: aws.String("3")},
{MD5OfMessageBody: &md5, MessageId: aws.String("012"), Id: aws.String("4")},
},
}
})
err := req.Send()
if err == nil {
t.Fatalf("expect error, got nil")
}
if e, a := "InvalidChecksum", err.(awserr.Error).Code(); e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := err.(awserr.Error).Message(), "invalid messages: 456, 789"; !strings.Contains(a, e) {
t.Errorf("expect %v to be in %v, was not", e, a)
}
}
```
|
```c
/*
*
*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <stdbool.h>
#include <stddef.h>
#include <sys/param.h>
#include "esp_log.h"
#include "esp_heap_caps.h"
#include "driver/gpio.h"
#include "sd_protocol_defs.h"
#include "driver/sdspi_host.h"
#include "sdspi_private.h"
#include "sdspi_crc.h"
#include "esp_timer.h"
#include "freertos/FreeRTOS.h"
#include "freertos/semphr.h"
#include "soc/soc_memory_layout.h"
/// Max number of transactions in flight (used in start_command_write_blocks)
#define SDSPI_TRANSACTION_COUNT 4
#define SDSPI_MOSI_IDLE_VAL 0xff //!< Data value which causes MOSI to stay high
#define GPIO_UNUSED 0xff //!< Flag indicating that CD/WP is unused
/// Size of the buffer returned by get_block_buf
#define SDSPI_BLOCK_BUF_SIZE (SDSPI_MAX_DATA_LEN + 4)
/// Maximum number of dummy bytes between the request and response (minimum is 1)
#define SDSPI_RESPONSE_MAX_DELAY 8
/**
* @brief Structure containing run time configuration for a single SD slot
*
* The slot info is referenced to by an sdspi_dev_handle_t (alias int). The handle may be the raw
* pointer to the slot info itself (force converted to, new API in IDFv4.2), or the index of the
* s_slot array (deprecated API). Returning the raw pointer to the caller instead of storing it
* locally can save some static memory.
*/
typedef struct {
spi_host_device_t host_id; //!< SPI host id.
spi_device_handle_t spi_handle; //!< SPI device handle, used for transactions
uint8_t gpio_cs; //!< CS GPIO, or GPIO_UNUSED
uint8_t gpio_cd; //!< Card detect GPIO, or GPIO_UNUSED
uint8_t gpio_wp; //!< Write protect GPIO, or GPIO_UNUSED
uint8_t gpio_int; //!< Write protect GPIO, or GPIO_UNUSED
/// GPIO write protect polarity.
/// 0 means "active low", i.e. card is protected when the GPIO is low;
/// 1 means "active high", i.e. card is protected when GPIO is high.
uint8_t gpio_wp_polarity : 1;
/// Set to 1 if the higher layer has asked the card to enable CRC checks
uint8_t data_crc_enabled : 1;
/// Intermediate buffer used when application buffer is not in DMA memory;
/// allocated on demand, SDSPI_BLOCK_BUF_SIZE bytes long. May be zero.
uint8_t* block_buf;
/// semaphore of gpio interrupt
SemaphoreHandle_t semphr_int;
} slot_info_t;
// Reserved for old API to be back-compatible
static slot_info_t *s_slots[SOC_SPI_PERIPH_NUM] = {};
static const char *TAG = "sdspi_host";
static const bool use_polling = true;
static const bool no_use_polling = true;
/// Functions to send out different kinds of commands
static esp_err_t start_command_read_blocks(slot_info_t *slot, sdspi_hw_cmd_t *cmd,
uint8_t *data, uint32_t rx_length, bool need_stop_command);
static esp_err_t start_command_write_blocks(slot_info_t *slot, sdspi_hw_cmd_t *cmd,
const uint8_t *data, uint32_t tx_length, bool multi_block, bool stop_trans);
static esp_err_t start_command_default(slot_info_t *slot, int flags, sdspi_hw_cmd_t *cmd);
static esp_err_t shift_cmd_response(sdspi_hw_cmd_t *cmd, int sent_bytes);
static esp_err_t poll_busy(slot_info_t *slot, int timeout_ms, bool polling);
/// A few helper functions
/// Map handle to pointer of slot information
static slot_info_t* get_slot_info(sdspi_dev_handle_t handle)
{
if ((uint32_t) handle < SOC_SPI_PERIPH_NUM) {
return s_slots[handle];
} else {
return (slot_info_t *) handle;
}
}
/// Store slot information (if possible) and return corresponding handle
static sdspi_dev_handle_t store_slot_info(slot_info_t *slot)
{
/*
* To be back-compatible, the first device of each bus will always be stored locally, and
* referenced to by the handle `host_id`, otherwise the new API return the raw pointer to the
* slot info as the handle, to save some static memory.
*/
if (s_slots[slot->host_id] == NULL) {
s_slots[slot->host_id] = slot;
return slot->host_id;
} else {
return (sdspi_dev_handle_t)slot;
}
}
/// Get the slot info for a specific handle, and remove the local reference (if exist).
static slot_info_t* remove_slot_info(sdspi_dev_handle_t handle)
{
if ((uint32_t) handle < SOC_SPI_PERIPH_NUM) {
slot_info_t* slot = s_slots[handle];
s_slots[handle] = NULL;
return slot;
} else {
return (slot_info_t *) handle;
}
}
/// Set CS high for given slot
static void cs_high(slot_info_t *slot)
{
if (slot->gpio_cs != GPIO_UNUSED) {
gpio_set_level(slot->gpio_cs, 1);
}
}
/// Set CS low for given slot
static void cs_low(slot_info_t *slot)
{
if (slot->gpio_cs != GPIO_UNUSED) {
gpio_set_level(slot->gpio_cs, 0);
}
}
/// Return true if WP pin is configured and is set as per its polarity
static bool card_write_protected(slot_info_t *slot)
{
if (slot->gpio_wp == GPIO_UNUSED) {
return false;
}
return gpio_get_level(slot->gpio_wp) == (slot->gpio_wp_polarity ? 1 : 0);
}
/// Return true if CD pin is configured and is high
static bool card_missing(slot_info_t *slot)
{
if (slot->gpio_cd == GPIO_UNUSED) {
return false;
}
return gpio_get_level(slot->gpio_cd) == 1;
}
/// Get pointer to a block of DMA memory, allocate if necessary.
/// This is used if the application provided buffer is not in DMA capable memory.
static esp_err_t get_block_buf(slot_info_t *slot, uint8_t **out_buf)
{
if (slot->block_buf == NULL) {
slot->block_buf = heap_caps_malloc(SDSPI_BLOCK_BUF_SIZE, MALLOC_CAP_DMA);
if (slot->block_buf == NULL) {
return ESP_ERR_NO_MEM;
}
}
*out_buf = slot->block_buf;
return ESP_OK;
}
/// Clock out one byte (CS has to be high) to make the card release MISO
/// (clocking one bit would work as well, but that triggers a bug in SPI DMA)
static void release_bus(slot_info_t *slot)
{
spi_transaction_t t = {
.flags = SPI_TRANS_USE_RXDATA | SPI_TRANS_USE_TXDATA,
.length = 8,
.tx_data = {0xff}
};
spi_device_polling_transmit(slot->spi_handle, &t);
// don't care if this failed
}
/// Clock out 80 cycles (10 bytes) before GO_IDLE command
static void go_idle_clockout(slot_info_t *slot)
{
//actually we need 10, declare 12 to meet requirement of RXDMA
uint8_t data[12];
memset(data, 0xff, sizeof(data));
spi_transaction_t t = {
.length = 10 * 8,
.tx_buffer = data,
.rx_buffer = data,
};
spi_device_polling_transmit(slot->spi_handle, &t);
// don't care if this failed
}
/**
* (Re)Configure SPI device. Used to change clock speed.
* @param slot Pointer to the slot to be configured
* @param clock_speed_hz clock speed, Hz
* @return ESP_OK on success
*/
static esp_err_t configure_spi_dev(slot_info_t *slot, int clock_speed_hz)
{
if (slot->spi_handle) {
// Reinitializing
spi_bus_remove_device(slot->spi_handle);
slot->spi_handle = NULL;
}
spi_device_interface_config_t devcfg = {
.clock_speed_hz = clock_speed_hz,
.mode = 0,
// For SD cards, CS must stay low during the whole read/write operation,
// rather than a single SPI transaction.
.spics_io_num = GPIO_NUM_NC,
.queue_size = SDSPI_TRANSACTION_COUNT,
};
return spi_bus_add_device(slot->host_id, &devcfg, &slot->spi_handle);
}
esp_err_t sdspi_host_init(void)
{
return ESP_OK;
}
static esp_err_t deinit_slot(slot_info_t *slot)
{
esp_err_t err = ESP_OK;
if (slot->spi_handle) {
spi_bus_remove_device(slot->spi_handle);
slot->spi_handle = NULL;
free(slot->block_buf);
slot->block_buf = NULL;
}
uint64_t pin_bit_mask = 0;
if (slot->gpio_cs != GPIO_UNUSED) {
pin_bit_mask |= BIT64(slot->gpio_cs);
}
if (slot->gpio_cd != GPIO_UNUSED) {
pin_bit_mask |= BIT64(slot->gpio_cd);
}
if (slot->gpio_wp != GPIO_UNUSED) {
pin_bit_mask |= BIT64(slot->gpio_wp);
}
if (slot->gpio_int != GPIO_UNUSED) {
pin_bit_mask |= BIT64(slot->gpio_int);
gpio_intr_disable(slot->gpio_int);
gpio_isr_handler_remove(slot->gpio_int);
}
gpio_config_t config = {
.pin_bit_mask = pin_bit_mask,
.mode = GPIO_MODE_INPUT,
.intr_type = GPIO_INTR_DISABLE,
};
if (pin_bit_mask != 0) {
gpio_config(&config);
}
if (slot->semphr_int) {
vSemaphoreDelete(slot->semphr_int);
slot->semphr_int = NULL;
}
free(slot);
return err;
}
esp_err_t sdspi_host_remove_device(sdspi_dev_handle_t handle)
{
//Get the slot info and remove the reference in the static memory (if used)
slot_info_t* slot = remove_slot_info(handle);
if (slot == NULL) {
return ESP_ERR_INVALID_ARG;
}
deinit_slot(slot);
return ESP_OK;
}
//only the slots locally stored can be deinit in this function.
esp_err_t sdspi_host_deinit(void)
{
for (size_t i = 0; i < sizeof(s_slots) / sizeof(s_slots[0]); ++i) {
slot_info_t* slot = remove_slot_info(i);
//slot isn't used, skip
if (slot == NULL) {
continue;
}
deinit_slot(slot);
}
return ESP_OK;
}
esp_err_t sdspi_host_set_card_clk(sdspi_dev_handle_t handle, uint32_t freq_khz)
{
slot_info_t *slot = get_slot_info(handle);
if (slot == NULL) {
return ESP_ERR_INVALID_ARG;
}
ESP_LOGD(TAG, "Setting card clock to %"PRIu32" kHz", freq_khz);
return configure_spi_dev(slot, freq_khz * 1000);
}
esp_err_t sdspi_host_get_real_freq(sdspi_dev_handle_t handle, int* real_freq_khz)
{
slot_info_t *slot = get_slot_info(handle);
if (slot == NULL) {
return ESP_ERR_INVALID_ARG;
}
return spi_device_get_actual_freq(slot->spi_handle, real_freq_khz);
}
static void gpio_intr(void* arg)
{
BaseType_t awoken = pdFALSE;
slot_info_t* slot = (slot_info_t*)arg;
xSemaphoreGiveFromISR(slot->semphr_int, &awoken);
gpio_intr_disable(slot->gpio_int);
if (awoken) {
portYIELD_FROM_ISR();
}
}
esp_err_t sdspi_host_init_device(const sdspi_device_config_t* slot_config, sdspi_dev_handle_t* out_handle)
{
ESP_LOGD(TAG, "%s: SPI%d cs=%d cd=%d wp=%d wp_polarity:%d",
__func__, slot_config->host_id + 1, slot_config->gpio_cs,
slot_config->gpio_cd, slot_config->gpio_wp, slot_config->gpio_wp_polarity);
slot_info_t* slot = (slot_info_t*)malloc(sizeof(slot_info_t));
if (slot == NULL) {
return ESP_ERR_NO_MEM;
}
*slot = (slot_info_t) {
.host_id = slot_config->host_id,
.gpio_cs = slot_config->gpio_cs,
};
// Attach the SD card to the SPI bus
esp_err_t ret = configure_spi_dev(slot, SDMMC_FREQ_PROBING * 1000);
if (ret != ESP_OK) {
ESP_LOGD(TAG, "spi_bus_add_device failed with rc=0x%x", ret);
goto cleanup;
}
// Configure CS pin
gpio_config_t io_conf = {
.intr_type = GPIO_INTR_DISABLE,
.mode = GPIO_MODE_OUTPUT,
.pin_bit_mask = 1ULL << slot_config->gpio_cs,
};
if (slot_config->gpio_cs != SDSPI_SLOT_NO_CS) {
slot->gpio_cs = slot_config->gpio_cs;
} else {
slot->gpio_cs = GPIO_UNUSED;
}
if (slot->gpio_cs != GPIO_UNUSED) {
ret = gpio_config(&io_conf);
if (ret != ESP_OK) {
ESP_LOGD(TAG, "gpio_config (CS) failed with rc=0x%x", ret);
goto cleanup;
}
cs_high(slot);
}
// Configure CD and WP pins
io_conf = (gpio_config_t) {
.intr_type = GPIO_INTR_DISABLE,
.mode = GPIO_MODE_INPUT,
.pin_bit_mask = 0,
.pull_up_en = true
};
if (slot_config->gpio_cd != SDSPI_SLOT_NO_CD) {
io_conf.pin_bit_mask |= (1ULL << slot_config->gpio_cd);
slot->gpio_cd = slot_config->gpio_cd;
} else {
slot->gpio_cd = GPIO_UNUSED;
}
if (slot_config->gpio_wp != SDSPI_SLOT_NO_WP) {
io_conf.pin_bit_mask |= (1ULL << slot_config->gpio_wp);
slot->gpio_wp = slot_config->gpio_wp;
slot->gpio_wp_polarity = slot_config->gpio_wp_polarity;
if (slot->gpio_wp_polarity) {
io_conf.pull_down_en = true;
io_conf.pull_up_en = false;
}
} else {
slot->gpio_wp = GPIO_UNUSED;
}
if (io_conf.pin_bit_mask != 0) {
ret = gpio_config(&io_conf);
if (ret != ESP_OK) {
ESP_LOGD(TAG, "gpio_config (CD/WP) failed with rc=0x%x", ret);
goto cleanup;
}
}
if (slot_config->gpio_int != SDSPI_SLOT_NO_INT) {
slot->gpio_int = slot_config->gpio_int;
io_conf = (gpio_config_t) {
.intr_type = GPIO_INTR_LOW_LEVEL,
.mode = GPIO_MODE_INPUT,
.pull_up_en = true,
.pin_bit_mask = (1ULL << slot_config->gpio_int),
};
ret = gpio_config(&io_conf);
if (ret != ESP_OK) {
ESP_LOGE(TAG, "gpio_config (interrupt) failed with rc=0x%x", ret);
goto cleanup;
}
slot->semphr_int = xSemaphoreCreateBinary();
if (slot->semphr_int == NULL) {
ret = ESP_ERR_NO_MEM;
goto cleanup;
}
gpio_intr_disable(slot->gpio_int);
// 1. the interrupt is better to be disabled before the ISR is registered
// 2. the semaphore MUST be initialized before the ISR is registered
// 3. the gpio_int member should be filled before the ISR is registered
ret = gpio_isr_handler_add(slot->gpio_int, &gpio_intr, slot);
if (ret != ESP_OK) {
ESP_LOGE(TAG, "gpio_isr_handle_add failed with rc=0x%x", ret);
goto cleanup;
}
} else {
slot->gpio_int = GPIO_UNUSED;
}
//Initialization finished, store the store information if possible
//Then return corresponding handle
*out_handle = store_slot_info(slot);
return ESP_OK;
cleanup:
if (slot->semphr_int) {
vSemaphoreDelete(slot->semphr_int);
slot->semphr_int = NULL;
}
if (slot->spi_handle) {
spi_bus_remove_device(slot->spi_handle);
slot->spi_handle = NULL;
}
free(slot);
return ret;
}
esp_err_t sdspi_host_start_command(sdspi_dev_handle_t handle, sdspi_hw_cmd_t *cmd, void *data,
uint32_t data_size, int flags)
{
slot_info_t *slot = get_slot_info(handle);
if (slot == NULL) {
return ESP_ERR_INVALID_ARG;
}
if (card_missing(slot)) {
return ESP_ERR_NOT_FOUND;
}
// save some parts of cmd, as its contents will be overwritten
int cmd_index = cmd->cmd_index;
uint32_t cmd_arg;
memcpy(&cmd_arg, cmd->arguments, sizeof(cmd_arg));
cmd_arg = __builtin_bswap32(cmd_arg);
ESP_LOGV(TAG, "%s: slot=%i, CMD%d, arg=0x%08"PRIx32" flags=0x%x, data=%p, data_size=%"PRIu32" crc=0x%02x",
__func__, handle, cmd_index, cmd_arg, flags, data, data_size, cmd->crc7);
spi_device_acquire_bus(slot->spi_handle, portMAX_DELAY);
poll_busy(slot, 40, true);
// For CMD0, clock out 80 cycles to help the card enter idle state,
// *before* CS is asserted.
if (cmd_index == MMC_GO_IDLE_STATE) {
go_idle_clockout(slot);
}
// actual transaction
esp_err_t ret = ESP_OK;
cs_low(slot);
if (flags & SDSPI_CMD_FLAG_DATA) {
const bool multi_block = flags & SDSPI_CMD_FLAG_MULTI_BLK;
//send stop transmission token only when multi-block write and non-SDIO mode
const bool stop_transmission = multi_block && !(flags & SDSPI_CMD_FLAG_RSP_R5);
if (flags & SDSPI_CMD_FLAG_WRITE) {
ret = start_command_write_blocks(slot, cmd, data, data_size, multi_block, stop_transmission);
} else {
ret = start_command_read_blocks(slot, cmd, data, data_size, stop_transmission);
}
} else {
ret = start_command_default(slot, flags, cmd);
}
cs_high(slot);
release_bus(slot);
spi_device_release_bus(slot->spi_handle);
if (ret != ESP_OK) {
ESP_LOGD(TAG, "%s: cmd=%d error=0x%x", __func__, cmd_index, ret);
} else {
// Update internal state when some commands are sent successfully
if (cmd_index == SD_CRC_ON_OFF) {
slot->data_crc_enabled = (uint8_t) cmd_arg;
ESP_LOGD(TAG, "data CRC set=%d", slot->data_crc_enabled);
}
}
return ret;
}
static esp_err_t start_command_default(slot_info_t *slot, int flags, sdspi_hw_cmd_t *cmd)
{
size_t cmd_size = SDSPI_CMD_R1_SIZE;
if ((flags & SDSPI_CMD_FLAG_RSP_R1) ||
(flags & SDSPI_CMD_FLAG_NORSP) ||
(flags & SDSPI_CMD_FLAG_RSP_R1B)) {
cmd_size = SDSPI_CMD_R1_SIZE;
} else if (flags & SDSPI_CMD_FLAG_RSP_R2) {
cmd_size = SDSPI_CMD_R2_SIZE;
} else if (flags & SDSPI_CMD_FLAG_RSP_R3) {
cmd_size = SDSPI_CMD_R3_SIZE;
} else if (flags & SDSPI_CMD_FLAG_RSP_R4) {
cmd_size = SDSPI_CMD_R4_SIZE;
} else if (flags & SDSPI_CMD_FLAG_RSP_R5) {
cmd_size = SDSPI_CMD_R5_SIZE;
} else if (flags & SDSPI_CMD_FLAG_RSP_R7) {
cmd_size = SDSPI_CMD_R7_SIZE;
}
//add extra clocks to avoid polling
cmd_size += (SDSPI_NCR_MAX_SIZE - SDSPI_NCR_MIN_SIZE);
spi_transaction_t t = {
.flags = 0,
.length = cmd_size * 8,
.tx_buffer = cmd,
.rx_buffer = cmd,
};
esp_err_t ret = spi_device_polling_transmit(slot->spi_handle, &t);
if (cmd->cmd_index == MMC_STOP_TRANSMISSION) {
/* response is a stuff byte from previous transfer, ignore it */
cmd->r1 = 0xff;
}
if (ret != ESP_OK) {
ESP_LOGD(TAG, "%s: spi_device_polling_transmit returned 0x%x", __func__, ret);
return ret;
}
if (flags & SDSPI_CMD_FLAG_NORSP) {
/* no (correct) response expected from the card, so skip polling loop */
ESP_LOGV(TAG, "%s: ignoring response byte", __func__);
cmd->r1 = 0x00;
}
// we have sent and received bytes with enough length.
// now shift the response to match the offset of sdspi_hw_cmd_t
ret = shift_cmd_response(cmd, cmd_size);
if (ret != ESP_OK) {
return ESP_ERR_TIMEOUT;
}
if (flags & SDSPI_CMD_FLAG_RSP_R1B) {
ret = poll_busy(slot, cmd->timeout_ms, no_use_polling);
if (ret != ESP_OK) {
return ret;
}
}
return ESP_OK;
}
// Wait until MISO goes high
static esp_err_t poll_busy(slot_info_t *slot, int timeout_ms, bool polling)
{
uint8_t t_rx;
spi_transaction_t t = {
.tx_buffer = &t_rx,
.flags = SPI_TRANS_USE_RXDATA, //data stored in rx_data
.length = 8,
};
esp_err_t ret;
int64_t t_end = esp_timer_get_time() + timeout_ms * 1000;
int nonzero_count = 0;
do {
t_rx = SDSPI_MOSI_IDLE_VAL;
t.rx_data[0] = 0;
if (polling) {
ret = spi_device_polling_transmit(slot->spi_handle, &t);
} else {
ret = spi_device_transmit(slot->spi_handle, &t);
}
if (ret != ESP_OK) {
return ret;
}
if (t.rx_data[0] != 0) {
if (++nonzero_count == 2) {
return ESP_OK;
}
}
} while (esp_timer_get_time() < t_end);
ESP_LOGD(TAG, "%s: timeout", __func__);
return ESP_ERR_TIMEOUT;
}
// Wait for data token, reading 8 bytes at a time.
// If the token is found, write all subsequent bytes to extra_ptr,
// and store the number of bytes written to extra_size.
static esp_err_t poll_data_token(slot_info_t *slot, uint8_t *extra_ptr, size_t *extra_size, int timeout_ms)
{
uint8_t t_rx[8];
spi_transaction_t t = {
.tx_buffer = &t_rx,
.rx_buffer = &t_rx,
.length = sizeof(t_rx) * 8,
};
esp_err_t ret;
int64_t t_end = esp_timer_get_time() + timeout_ms * 1000;
do {
memset(t_rx, SDSPI_MOSI_IDLE_VAL, sizeof(t_rx));
ret = spi_device_polling_transmit(slot->spi_handle, &t);
if (ret != ESP_OK) {
return ret;
}
bool found = false;
for (size_t byte_idx = 0; byte_idx < sizeof(t_rx); byte_idx++) {
uint8_t rd_data = t_rx[byte_idx];
if (rd_data == TOKEN_BLOCK_START) {
found = true;
memcpy(extra_ptr, t_rx + byte_idx + 1, sizeof(t_rx) - byte_idx - 1);
*extra_size = sizeof(t_rx) - byte_idx - 1;
break;
}
if (rd_data != 0xff && rd_data != 0) {
ESP_LOGD(TAG, "%s: received 0x%02x while waiting for data",
__func__, rd_data);
return ESP_ERR_INVALID_RESPONSE;
}
}
if (found) {
return ESP_OK;
}
} while (esp_timer_get_time() < t_end);
ESP_LOGD(TAG, "%s: timeout", __func__);
return ESP_ERR_TIMEOUT;
}
// the r1 respond could appear 1-8 clocks after the command token is sent
// this function search for r1 in the buffer after 1 clocks to max 8 clocks
// then shift the data after R1, to match the definition of sdspi_hw_cmd_t.
static esp_err_t shift_cmd_response(sdspi_hw_cmd_t* cmd, int sent_bytes)
{
uint8_t* pr1 = &cmd->r1;
int ncr_cnt = 1;
while (true) {
if ((*pr1 & SD_SPI_R1_NO_RESPONSE) == 0) {
break;
}
pr1++;
if (++ncr_cnt > 8) {
return ESP_ERR_NOT_FOUND;
}
}
int copy_bytes = sent_bytes - SDSPI_CMD_SIZE - ncr_cnt;
if (copy_bytes > 0) {
memcpy(&cmd->r1, pr1, copy_bytes);
}
return ESP_OK;
}
/**
* Receiving one or more blocks of data happens as follows:
* 1. send command + receive r1 response (SDSPI_CMD_R1_SIZE bytes total)
* 2. keep receiving bytes until TOKEN_BLOCK_START is encountered (this may
* take a while, depending on card's read speed)
* 3. receive up to SDSPI_MAX_DATA_LEN = 512 bytes of actual data
* 4. receive 2 bytes of CRC
* 5. for multi block transfers, go to step 2
*
* These steps can be done separately, but that leads to a less than optimal
* performance on large transfers because of delays between each step.
* For example, if steps 3 and 4 are separate SPI transactions queued one after
* another, there will be ~16 microseconds of dead time between end of step 3
* and the beginning of step 4. A delay between two blocking SPI transactions
* in step 2 is even higher (~60 microseconds).
*
* To improve read performance the following sequence is adopted:
* 1. Do the first transfer: command + r1 response + 8 extra bytes.
* Set pre_scan_data_ptr to point to the 8 extra bytes, and set
* pre_scan_data_size to 8.
* 2. Search pre_scan_data_size bytes for TOKEN_BLOCK_START.
* If found, the rest of the bytes contain part of the actual data.
* Store pointer to and size of that extra data as extra_data_{ptr,size}.
* If not found, fall back to polling for TOKEN_BLOCK_START, 8 bytes at a
* time (in poll_data_token function). Deal with extra data in the same way,
* by setting extra_data_{ptr,size}.
* 3. Receive the remaining 512 - extra_data_size bytes, plus 4 extra bytes
* (i.e. 516 - extra_data_size). Of the 4 extra bytes, first two will capture
* the CRC value, and the other two will capture 0xff 0xfe sequence
* indicating the start of the next block. Actual scanning is done by
* setting pre_scan_data_ptr to point to these last 2 bytes, and setting
* pre_scan_data_size = 2, then going to step 2 to receive the next block.
* When the final block is being received, the number of extra bytes is 2
* (only for CRC), because we don't need to wait for start token of the
* next block, and some cards are getting confused by these two extra bytes.
*
* With this approach the delay between blocks of a multi-block transfer is
* ~95 microseconds, out of which 35 microseconds are spend doing the CRC check.
* Further speedup is possible by pipelining transfers and CRC checks, at an
* expense of one extra temporary buffer.
*/
static esp_err_t start_command_read_blocks(slot_info_t *slot, sdspi_hw_cmd_t *cmd,
uint8_t *data, uint32_t rx_length, bool need_stop_command)
{
spi_transaction_t t_command = {
.length = (SDSPI_CMD_R1_SIZE + SDSPI_RESPONSE_MAX_DELAY) * 8,
.tx_buffer = cmd,
.rx_buffer = cmd,
};
esp_err_t ret = spi_device_polling_transmit(slot->spi_handle, &t_command);
if (ret != ESP_OK) {
return ret;
}
uint8_t* cmd_u8 = (uint8_t*) cmd;
size_t pre_scan_data_size = SDSPI_RESPONSE_MAX_DELAY;
uint8_t* pre_scan_data_ptr = cmd_u8 + SDSPI_CMD_R1_SIZE;
/* R1 response is delayed by 1-8 bytes from the request.
* This loop searches for the response and writes it to cmd->r1.
*/
while ((cmd->r1 & SD_SPI_R1_NO_RESPONSE) != 0 && pre_scan_data_size > 0) {
cmd->r1 = *pre_scan_data_ptr;
++pre_scan_data_ptr;
--pre_scan_data_size;
}
if (cmd->r1 & SD_SPI_R1_NO_RESPONSE) {
ESP_LOGD(TAG, "no response token found");
return ESP_ERR_TIMEOUT;
}
while (rx_length > 0) {
size_t extra_data_size = 0;
const uint8_t* extra_data_ptr = NULL;
bool need_poll = true;
for (size_t i = 0; i < pre_scan_data_size; ++i) {
if (pre_scan_data_ptr[i] == TOKEN_BLOCK_START) {
extra_data_size = pre_scan_data_size - i - 1;
extra_data_ptr = pre_scan_data_ptr + i + 1;
need_poll = false;
break;
}
}
if (need_poll) {
// Wait for data to be ready
ret = poll_data_token(slot, cmd_u8 + SDSPI_CMD_R1_SIZE, &extra_data_size, cmd->timeout_ms);
if (ret != ESP_OK) {
return ret;
}
if (extra_data_size) {
extra_data_ptr = cmd_u8 + SDSPI_CMD_R1_SIZE;
}
}
// Arrange RX buffer
size_t will_receive = MIN(rx_length, SDSPI_MAX_DATA_LEN) - extra_data_size;
uint8_t* rx_data;
ret = get_block_buf(slot, &rx_data);
if (ret != ESP_OK) {
return ret;
}
// receive actual data
const size_t receive_extra_bytes = (rx_length > SDSPI_MAX_DATA_LEN) ? 4 : 2;
memset(rx_data, 0xff, will_receive + receive_extra_bytes);
spi_transaction_t t_data = {
.length = (will_receive + receive_extra_bytes) * 8,
.rx_buffer = rx_data,
.tx_buffer = rx_data
};
ret = spi_device_transmit(slot->spi_handle, &t_data);
if (ret != ESP_OK) {
return ret;
}
// CRC bytes need to be received even if CRC is not enabled
uint16_t crc = UINT16_MAX;
memcpy(&crc, rx_data + will_receive, sizeof(crc));
// Bytes to scan for the start token
pre_scan_data_size = receive_extra_bytes - sizeof(crc);
pre_scan_data_ptr = rx_data + will_receive + sizeof(crc);
// Copy data to the destination buffer
memcpy(data + extra_data_size, rx_data, will_receive);
if (extra_data_size) {
memcpy(data, extra_data_ptr, extra_data_size);
}
// compute CRC of the received data
uint16_t crc_of_data = 0;
if (slot->data_crc_enabled) {
crc_of_data = sdspi_crc16(data, will_receive + extra_data_size);
if (crc_of_data != crc) {
ESP_LOGE(TAG, "data CRC failed, got=0x%04x expected=0x%04x", crc_of_data, crc);
ESP_LOG_BUFFER_HEX(TAG, data, 16);
return ESP_ERR_INVALID_CRC;
}
}
data += will_receive + extra_data_size;
rx_length -= will_receive + extra_data_size;
extra_data_size = 0;
extra_data_ptr = NULL;
}
if (need_stop_command) {
// To end multi block transfer, send stop command and wait for the
// card to process it
sdspi_hw_cmd_t stop_cmd;
make_hw_cmd(MMC_STOP_TRANSMISSION, 0, cmd->timeout_ms, &stop_cmd);
ret = start_command_default(slot, SDSPI_CMD_FLAG_RSP_R1B, &stop_cmd);
if (ret != ESP_OK) {
return ret;
}
if (stop_cmd.r1 != 0) {
ESP_LOGD(TAG, "%s: STOP_TRANSMISSION response 0x%02x", __func__, stop_cmd.r1);
}
ret = poll_busy(slot, cmd->timeout_ms, use_polling);
if (ret != ESP_OK) {
return ret;
}
}
return ESP_OK;
}
/* For CMD53, we can send in byte mode, or block mode
* The data start token is different, and cannot be determined by the length
* That's why we need ``multi_block``.
* It's also different that stop transmission token is not needed in the SDIO mode.
*/
static esp_err_t start_command_write_blocks(slot_info_t *slot, sdspi_hw_cmd_t *cmd,
const uint8_t *data, uint32_t tx_length, bool multi_block, bool stop_trans)
{
if (card_write_protected(slot)) {
ESP_LOGW(TAG, "%s: card write protected", __func__);
return ESP_ERR_INVALID_STATE;
}
// Send the minimum length that is sure to get the complete response
// SD cards always return R1 (1bytes), SDIO returns R5 (2 bytes)
const int send_bytes = SDSPI_CMD_R5_SIZE + SDSPI_NCR_MAX_SIZE - SDSPI_NCR_MIN_SIZE;
spi_transaction_t t_command = {
.length = send_bytes * 8,
.tx_buffer = cmd,
.rx_buffer = cmd,
};
esp_err_t ret = spi_device_polling_transmit(slot->spi_handle, &t_command);
if (ret != ESP_OK) {
return ret;
}
// check if command response valid
ret = shift_cmd_response(cmd, send_bytes);
if (ret != ESP_OK) {
ESP_LOGD(TAG, "%s: check_cmd_response returned 0x%x", __func__, ret);
return ret;
}
uint8_t start_token = multi_block ?
TOKEN_BLOCK_START_WRITE_MULTI : TOKEN_BLOCK_START;
while (tx_length > 0) {
// Write block start token
spi_transaction_t t_start_token = {
.length = sizeof(start_token) * 8,
.tx_buffer = &start_token
};
ret = spi_device_polling_transmit(slot->spi_handle, &t_start_token);
if (ret != ESP_OK) {
return ret;
}
// Prepare data to be sent
size_t will_send = MIN(tx_length, SDSPI_MAX_DATA_LEN);
const uint8_t* tx_data = data;
if (!esp_ptr_in_dram(tx_data)) {
// If the pointer can't be used with DMA, copy data into a new buffer
uint8_t* tmp;
ret = get_block_buf(slot, &tmp);
if (ret != ESP_OK) {
return ret;
}
memcpy(tmp, tx_data, will_send);
tx_data = tmp;
}
// Write data
spi_transaction_t t_data = {
.length = will_send * 8,
.tx_buffer = tx_data,
};
ret = spi_device_transmit(slot->spi_handle, &t_data);
if (ret != ESP_OK) {
return ret;
}
// Write CRC and get the response in one transaction
uint16_t crc = sdspi_crc16(data, will_send);
const int size_crc_response = sizeof(crc) + 1;
spi_transaction_t t_crc_rsp = {
.length = size_crc_response * 8,
.flags = SPI_TRANS_USE_TXDATA | SPI_TRANS_USE_RXDATA,
};
memset(t_crc_rsp.tx_data, 0xff, 4);
memcpy(t_crc_rsp.tx_data, &crc, sizeof(crc));
ret = spi_device_polling_transmit(slot->spi_handle, &t_crc_rsp);
if (ret != ESP_OK) {
return ret;
}
uint8_t data_rsp = t_crc_rsp.rx_data[2];
if (!SD_SPI_DATA_RSP_VALID(data_rsp)) {
return ESP_ERR_INVALID_RESPONSE;
}
switch (SD_SPI_DATA_RSP(data_rsp)) {
case SD_SPI_DATA_ACCEPTED:
break;
case SD_SPI_DATA_CRC_ERROR:
return ESP_ERR_INVALID_CRC;
case SD_SPI_DATA_WR_ERROR:
return ESP_FAIL;
default:
return ESP_ERR_INVALID_RESPONSE;
}
// Wait for the card to finish writing data
ret = poll_busy(slot, cmd->timeout_ms, no_use_polling);
if (ret != ESP_OK) {
return ret;
}
tx_length -= will_send;
data += will_send;
}
if (stop_trans) {
uint8_t stop_token[2] = {
TOKEN_BLOCK_STOP_WRITE_MULTI,
SDSPI_MOSI_IDLE_VAL
};
spi_transaction_t t_stop_token = {
.length = sizeof(stop_token) * 8,
.tx_buffer = &stop_token,
};
ret = spi_device_polling_transmit(slot->spi_handle, &t_stop_token);
if (ret != ESP_OK) {
return ret;
}
ret = poll_busy(slot, cmd->timeout_ms, use_polling);
if (ret != ESP_OK) {
return ret;
}
}
return ESP_OK;
}
esp_err_t sdspi_host_io_int_enable(sdspi_dev_handle_t handle)
{
//the pin and its interrupt is already initialized, nothing to do here.
return ESP_OK;
}
//the interrupt will give the semaphore and then disable itself
esp_err_t sdspi_host_io_int_wait(sdspi_dev_handle_t handle, TickType_t timeout_ticks)
{
slot_info_t* slot = get_slot_info(handle);
//skip the interrupt and semaphore if the gpio is already low.
if (gpio_get_level(slot->gpio_int) == 0) {
return ESP_OK;
}
//clear the semaphore before wait
xSemaphoreTake(slot->semphr_int, 0);
//enable the interrupt and wait for the semaphore
gpio_intr_enable(slot->gpio_int);
BaseType_t ret = xSemaphoreTake(slot->semphr_int, timeout_ticks);
if (ret == pdFALSE) {
gpio_intr_disable(slot->gpio_int);
return ESP_ERR_TIMEOUT;
}
return ESP_OK;
}
esp_err_t sdspi_host_get_dma_info(int slot, esp_dma_mem_info_t *dma_mem_info)
{
(void)slot;
dma_mem_info->extra_heap_caps = MALLOC_CAP_DMA;
dma_mem_info->dma_alignment_bytes = 4;
return ESP_OK;
}
```
|
```c++
// your_sha256_hash------------
// - Open3D: www.open3d.org -
// your_sha256_hash------------
// your_sha256_hash------------
#include "open3d/utility/Console.h"
#include <Eigen/Core>
#include <string>
#include <vector>
#include "open3d/utility/Helper.h"
namespace open3d {
namespace utility {
std::string GetProgramOptionAsString(
int argc,
char **argv,
const std::string &option,
const std::string &default_value /* = ""*/) {
char **itr = std::find(argv, argv + argc, option);
if (itr != argv + argc && ++itr != argv + argc) {
return std::string(*itr);
}
return default_value;
}
int GetProgramOptionAsInt(int argc,
char **argv,
const std::string &option,
const int default_value /* = 0*/) {
std::string str = GetProgramOptionAsString(argc, argv, option, "");
if (str.length() == 0) {
return default_value;
}
char *end;
errno = 0;
long l = std::strtol(str.c_str(), &end, 0);
if ((errno == ERANGE && l == LONG_MAX) || l > INT_MAX) {
return default_value;
} else if ((errno == ERANGE && l == LONG_MIN) || l < INT_MIN) {
return default_value;
} else if (*end != '\0') {
return default_value;
}
return (int)l;
}
double GetProgramOptionAsDouble(int argc,
char **argv,
const std::string &option,
const double default_value /* = 0.0*/) {
std::string str = GetProgramOptionAsString(argc, argv, option, "");
if (str.length() == 0) {
return default_value;
}
char *end;
errno = 0;
double l = std::strtod(str.c_str(), &end);
if (errno == ERANGE && (l == HUGE_VAL || l == -HUGE_VAL)) {
return default_value;
} else if (*end != '\0') {
return default_value;
}
return l;
}
Eigen::VectorXd GetProgramOptionAsEigenVectorXd(
int argc,
char **argv,
const std::string &option,
const Eigen::VectorXd default_value /* =
Eigen::VectorXd::Zero()*/) {
std::string str = GetProgramOptionAsString(argc, argv, option, "");
if (str.length() == 0 || (!(str.front() == '(' && str.back() == ')') &&
!(str.front() == '[' && str.back() == ']') &&
!(str.front() == '<' && str.back() == '>'))) {
return default_value;
}
std::vector<std::string> tokens =
SplitString(str.substr(1, str.length() - 2), ",");
Eigen::VectorXd vec(tokens.size());
for (size_t i = 0; i < tokens.size(); i++) {
char *end;
errno = 0;
double l = std::strtod(tokens[i].c_str(), &end);
if (errno == ERANGE && (l == HUGE_VAL || l == -HUGE_VAL)) {
return default_value;
} else if (*end != '\0') {
return default_value;
}
vec(i) = l;
}
return vec;
}
bool ProgramOptionExists(int argc, char **argv, const std::string &option) {
return std::find(argv, argv + argc, option) != argv + argc;
}
bool ProgramOptionExistsAny(int argc,
char **argv,
const std::vector<std::string> &options) {
for (const auto &option : options) {
if (ProgramOptionExists(argc, argv, option)) {
return true;
}
}
return false;
}
} // namespace utility
} // namespace open3d
```
|
Asaph (Hebrew: אָסַף) is an ancient name that means "God has gathered" and may refer to:
Asaph (biblical figure), the name of several Biblical figures
Psalms of Asaph
Asaph the Jew, sixth-century Jewish physician, author of:
Book of Assaf
Saint Asaph, first bishop of the diocese of Saint Asaph in Wales
Diocese of St Asaph
St Asaph, a city in North Wales
Asaph (album)
Asaph Hall, nineteenth century astronomer
Asaph Hall Jr., son of the above
Asaph Fipke, Canadian animator
St. Asaph Road, Croydon
|
```javascript
define([
"../core"
], function( jQuery ) {
/**
* Determines whether an object can have data
*/
jQuery.acceptData = function( owner ) {
// Accepts only:
// - Node
// - Node.ELEMENT_NODE
// - Node.DOCUMENT_NODE
// - Object
// - Any
/* jshint -W018 */
return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType );
};
return jQuery.acceptData;
});
```
|
```python
# tests.test_cluster.test_silhouette
# Tests for the SilhouetteVisualizer
#
# Author: Benjamin Bengfort
# Created: Mon Mar 27 10:01:37 2017 -0400
#
# For license information, see LICENSE.txt
#
# ID: test_silhouette.py [57b563b] benjamin@bengfort.com $
"""
Tests for the SilhouetteVisualizer
"""
##########################################################################
## Imports
##########################################################################
import sys
import pytest
import matplotlib.pyplot as plt
import numpy as np
from sklearn.datasets import make_blobs
from sklearn.cluster import KMeans, MiniBatchKMeans
from sklearn.cluster import SpectralClustering, AgglomerativeClustering
from unittest import mock
from tests.base import VisualTestCase
from yellowbrick.cluster.silhouette import SilhouetteVisualizer, silhouette_visualizer
##########################################################################
## SilhouetteVisualizer Test Cases
##########################################################################
class TestSilhouetteVisualizer(VisualTestCase):
"""
Silhouette Visualizer Tests
"""
@pytest.mark.xfail(sys.platform == "win32", reason="images not close on windows")
def test_integrated_kmeans_silhouette(self):
"""
Test no exceptions for kmeans silhouette visualizer on blobs dataset
"""
# NOTE see #182: cannot use occupancy dataset because of memory usage
# Generate a blobs data set
X, y = make_blobs(
n_samples=1000, n_features=12, centers=8, shuffle=False, random_state=0
)
fig = plt.figure()
ax = fig.add_subplot()
visualizer = SilhouetteVisualizer(KMeans(random_state=0), ax=ax)
visualizer.fit(X)
visualizer.finalize()
self.assert_images_similar(visualizer, remove_legend=True)
@pytest.mark.xfail(sys.platform == "win32", reason="images not close on windows")
def test_integrated_mini_batch_kmeans_silhouette(self):
"""
Test no exceptions for mini-batch kmeans silhouette visualizer
"""
# NOTE see #182: cannot use occupancy dataset because of memory usage
# Generate a blobs data set
X, y = make_blobs(
n_samples=1000, n_features=12, centers=8, shuffle=False, random_state=0
)
fig = plt.figure()
ax = fig.add_subplot()
visualizer = SilhouetteVisualizer(MiniBatchKMeans(random_state=0), ax=ax)
visualizer.fit(X)
visualizer.finalize()
self.assert_images_similar(visualizer, remove_legend=True)
@pytest.mark.skip(reason="no negative silhouette example available yet")
def test_negative_silhouette_score(self):
"""
Ensure negative silhouette scores are correctly displayed by the visualizer.
"""
raise NotImplementedError("no negative silhouette example available")
@pytest.mark.xfail(sys.platform == "win32", reason="images not close on windows")
def test_colormap_silhouette(self):
"""
Test no exceptions for modifying the colormap in a silhouette visualizer
"""
# Generate a blobs data set
X, y = make_blobs(
n_samples=1000, n_features=12, centers=8, shuffle=False, random_state=0
)
fig = plt.figure()
ax = fig.add_subplot()
visualizer = SilhouetteVisualizer(
MiniBatchKMeans(random_state=0), ax=ax, colormap="gnuplot"
)
visualizer.fit(X)
visualizer.finalize()
self.assert_images_similar(visualizer, remove_legend=True)
@pytest.mark.xfail(sys.platform == "win32", reason="images not close on windows")
def test_colors_silhouette(self):
"""
Test no exceptions for modifying the colors in a silhouette visualizer
with a list of color names
"""
# Generate a blobs data set
X, y = make_blobs(
n_samples=1000, n_features=12, centers=8, shuffle=False, random_state=0
)
fig = plt.figure()
ax = fig.add_subplot()
visualizer = SilhouetteVisualizer(
MiniBatchKMeans(random_state=0),
ax=ax,
colors=["red", "green", "blue", "indigo", "cyan", "lavender"],
)
visualizer.fit(X)
visualizer.finalize()
self.assert_images_similar(visualizer, remove_legend=True)
def test_colormap_as_colors_silhouette(self):
"""
Test no exceptions for modifying the colors in a silhouette visualizer
by using a matplotlib colormap as colors
"""
# Generate a blobs data set
X, y = make_blobs(
n_samples=1000, n_features=12, centers=8, shuffle=False, random_state=0
)
fig = plt.figure()
ax = fig.add_subplot()
visualizer = SilhouetteVisualizer(
MiniBatchKMeans(random_state=0), ax=ax, colors="cool"
)
visualizer.fit(X)
visualizer.finalize()
tol = (
3.2 if sys.platform == "win32" else 0.01
) # Fails on AppVeyor with RMS 3.143
self.assert_images_similar(visualizer, remove_legend=True, tol=tol)
def test_quick_method(self):
"""
Test the quick method producing a valid visualization
"""
X, y = make_blobs(
n_samples=1000, n_features=12, centers=8, shuffle=False, random_state=0
)
model = MiniBatchKMeans(3, random_state=343)
oz = silhouette_visualizer(model, X, show=False)
assert isinstance(oz, SilhouetteVisualizer)
self.assert_images_similar(oz)
def test_with_fitted(self):
"""
Test that visualizer properly handles an already-fitted model
"""
X, y = make_blobs(
n_samples=100, n_features=5, centers=3, shuffle=False, random_state=112
)
model = MiniBatchKMeans().fit(X)
labels = model.predict(X)
with mock.patch.object(model, "fit") as mockfit:
oz = SilhouetteVisualizer(model)
oz.fit(X)
mockfit.assert_not_called()
with mock.patch.object(model, "fit") as mockfit:
oz = SilhouetteVisualizer(model, is_fitted=True)
oz.fit(X)
mockfit.assert_not_called()
with mock.patch.object(model, "fit_predict", return_value=labels) as mockfit:
oz = SilhouetteVisualizer(model, is_fitted=False)
oz.fit(X)
mockfit.assert_called_once_with(X, None)
@pytest.mark.parametrize(
"model",
[SpectralClustering, AgglomerativeClustering],
)
def test_clusterer_without_predict(self, model):
"""
Assert that clustering estimators that don't implement
a predict() method utilize fit_predict()
"""
X = np.array([[1, 2], [1, 4], [1, 0], [4, 2], [4, 4], [4, 0]])
try:
visualizer = SilhouetteVisualizer(model(n_clusters=2))
visualizer.fit(X)
visualizer.finalize()
except AttributeError:
self.fail("could not use fit or fit_predict methods")
```
|
```objective-c
/****************************************************************************
* VCGLib o o *
* Visual and Computer Graphics Library o o *
* _ O _ *
* Visual Computing Lab /\/| *
* ISTI - Italian National Research Council | *
* \ *
* All rights reserved. *
* *
* This program is free software; you can redistribute it and/or modify *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* for more details. *
* *
****************************************************************************/
#ifndef __VCGLIB_QUADRIC
#define __VCGLIB_QUADRIC
#include <vcg/space/point3.h>
#include <vcg/space/plane3.h>
#include <vcg/math/matrix33.h>
#include <Eigen/Core>
namespace vcg {
namespace math {
/*
* This class encode a quadric function
* f(x) = xAx +bx + c
* where A is a symmetric 3x3 matrix, b a vector and c a scalar constant.
*/
template<typename _ScalarType>
class Quadric
{
public:
typedef _ScalarType ScalarType;
ScalarType a[6]; // Symmetric Matrix 3x3 : a11 a12 a13 a22 a23 a33
ScalarType b[3]; // Vector r3
ScalarType c; // Scalar (-1 means null/un-initialized quadric)
inline Quadric() { c = -1; }
bool IsValid() const { return c>=0; }
void SetInvalid() { c = -1.0; }
// Initialize the quadric to keep the squared distance from a given Plane
template< class PlaneType >
void ByPlane( const PlaneType & p )
{
a[0] = (ScalarType)p.Direction()[0]*p.Direction()[0]; // a11
a[1] = (ScalarType)p.Direction()[1]*p.Direction()[0]; // a12 (=a21)
a[2] = (ScalarType)p.Direction()[2]*p.Direction()[0]; // a13 (=a31)
a[3] = (ScalarType)p.Direction()[1]*p.Direction()[1]; // a22
a[4] = (ScalarType)p.Direction()[2]*p.Direction()[1]; // a23 (=a32)
a[5] = (ScalarType)p.Direction()[2]*p.Direction()[2]; // a33
b[0] = (ScalarType)(-2.0)*p.Offset()*p.Direction()[0];
b[1] = (ScalarType)(-2.0)*p.Offset()*p.Direction()[1];
b[2] = (ScalarType)(-2.0)*p.Offset()*p.Direction()[2];
c = (ScalarType)p.Offset()*p.Offset();
}
/*
* Initializes the quadric as the squared distance from a given line.
* Note that this code also works for a vcg::Ray<T>, even though the (squared) distance
* from a ray is different "before" its origin.
*/
template< class LineType >
void ByLine( const LineType & r ) // Init dato un raggio
{
ScalarType K = (ScalarType)(r.Origin()*r.Direction());
a[0] = (ScalarType)1.0-r.Direction()[0]*r.Direction()[0]; // a11
a[1] = (ScalarType)-r.Direction()[0]*r.Direction()[1]; // a12 (=a21)
a[2] = (ScalarType)-r.Direction()[0]*r.Direction()[2]; // a13 (=a31)
a[3] = (ScalarType)1.0-r.Direction()[1]*r.Direction()[1]; // a22
a[4] = (ScalarType)-r.Direction()[1]*r.Direction()[2]; // a23 (=a32)
a[5] = (ScalarType)1.0-r.Direction()[2]*r.Direction()[2]; // a33
b[0] = (ScalarType)2.0*(r.Direction()[0]*K - r.Origin()[0]);
b[1] = (ScalarType)2.0*(r.Direction()[1]*K - r.Origin()[1]);
b[2] = (ScalarType)2.0*(r.Direction()[2]*K - r.Origin()[2]);
c = -K*K + (ScalarType)(r.Origin()*r.Origin());
}
/*
* Initializes the quadric as the squared distance from a given point.
*
*/
template< class CoordType >
void ByPoint( const CoordType & p ) // Init dato un raggio
{
a[0] = 1; // a11
a[1] = 0; // a12 (=a21)
a[2] = 0; // a13 (=a31)
a[3] = 1; // a22
a[4] = 0; // a23 (=a32)
a[5] = 1; // a33
b[0] = (ScalarType)-2.0*((ScalarType)p.X());
b[1] = (ScalarType)-2.0*((ScalarType)p.Y());
b[2] = (ScalarType)-2.0*((ScalarType)p.Z());
c = pow(p.X(),2) + pow(p.Y(),2)+ pow(p.Z(),2);
}
void SetZero()
{
a[0] = 0;
a[1] = 0;
a[2] = 0;
a[3] = 0;
a[4] = 0;
a[5] = 0;
b[0] = 0;
b[1] = 0;
b[2] = 0;
c = 0;
}
void operator = ( const Quadric & q )
{
assert( q.IsValid() );
a[0] = q.a[0];
a[1] = q.a[1];
a[2] = q.a[2];
a[3] = q.a[3];
a[4] = q.a[4];
a[5] = q.a[5];
b[0] = q.b[0];
b[1] = q.b[1];
b[2] = q.b[2];
c = q.c;
}
void operator += ( const Quadric & q )
{
assert( IsValid() );
assert( q.IsValid() );
a[0] += q.a[0];
a[1] += q.a[1];
a[2] += q.a[2];
a[3] += q.a[3];
a[4] += q.a[4];
a[5] += q.a[5];
b[0] += q.b[0];
b[1] += q.b[1];
b[2] += q.b[2];
c += q.c;
}
void operator *= ( const ScalarType & w ) // Amplifica una quadirca
{
assert( IsValid() );
a[0] *= w;
a[1] *= w;
a[2] *= w;
a[3] *= w;
a[4] *= w;
a[5] *= w;
b[0] *= w;
b[1] *= w;
b[2] *= w;
c *= w;
}
/* Evaluate a quadric over a point p.
*/
template <class ResultScalarType>
ResultScalarType Apply( const Point3<ResultScalarType> & p ) const
{
assert( IsValid() );
return ResultScalarType (
p[0]*p[0]*a[0] + 2*p[0]*p[1]*a[1] + 2*p[0]*p[2]*a[2] + p[0]*b[0]
+ p[1]*p[1]*a[3] + 2*p[1]*p[2]*a[4] + p[1]*b[1]
+ p[2]*p[2]*a[5] + p[2]*b[2] + c);
}
static double &RelativeErrorThr()
{
static double _err = 0.000001;
return _err;
}
// Find the point minimizing the quadric xAx + bx + c
// by solving the first derivative 2 Ax + b = 0
// return true if the found solution fits the system.
template <class ReturnScalarType>
bool Minimum(Point3<ReturnScalarType> &x)
{
Eigen::Matrix3d A;
Eigen::Vector3d be;
A << a[0], a[1], a[2],
a[1], a[3], a[4],
a[2], a[4], a[5];
be << -b[0]/2, -b[1]/2, -b[2]/2;
// Eigen::Vector3d xe = A.colPivHouseholderQr().solve(bv);
// Eigen::Vector3d xe = A.partialPivLu().solve(bv);
Eigen::Vector3d xe = A.fullPivLu().solve(be);
// Check relative error of solution xe
double error = (A*xe - be).norm();
if(error > be.norm() * Quadric<ScalarType>::RelativeErrorThr() )
return false;
x.FromEigenVector(xe);
return true;
}
template <class ReturnScalarType>
bool MinimumClosestToPoint(Point3<ReturnScalarType> &x, const Point3<ReturnScalarType> &pt)
{
const double qeps = 1e-3;
Eigen::Matrix3d A;
Eigen::Vector3d be;
A << a[0], a[1], a[2],
a[1], a[3], a[4],
a[2], a[4], a[5];
be << -b[0]/2, -b[1]/2, -b[2]/2;
Eigen::JacobiSVD<Eigen::MatrixXd> svd(A, Eigen::ComputeThinU | Eigen::ComputeThinV);
Eigen::Vector3d s = svd.singularValues();
for(int i=1;i<3;++i)
if(s[i]/s[0] > qeps) s[i]=1/s[i];
else s[i]=0;
s[0]=1/s[0];
Eigen::Vector3d xp;
pt.ToEigenVector(xp);
Eigen::Vector3d xe = xp + (svd.matrixV()*s.asDiagonal()*(svd.matrixU().transpose())) *(be - A*xp);
x.FromEigenVector(xe);
return true;
}
};
typedef Quadric<short> Quadrics;
typedef Quadric<int> Quadrici;
typedef Quadric<float> Quadricf;
typedef Quadric<double> Quadricd;
} // end namespace math
} // end namespace vcg
#endif
```
|
Bill Tupou (born 2 July 1990) () is a former Tonga international rugby league footballer who last played as a or on the for Wakefield Trinity in the Super League.
He previously played for the New Zealand Warriors and the Canberra Raiders in the National Rugby League (NRL).
Background
Tupou was born in Auckland, New Zealand.
Early years
Tupou attended Kelston Boys High School and played for the Bay Roskill Vikings and Marist Saints in the Auckland Rugby League competition.
Tupou represented the New Zealand Under-16 side and also represented Auckland Under-16 teams.
Playing career
With the creation of the Toyota Cup in 2008 Tupou joined the New Zealand Warriors under-20 side and scored 14 tries in 19 games. He repeated this effort in 2009, scoring 14 tries in just 17 games.
Tupou was one of a small group of players still eligible for the side in 2010. In all, Tupou played 51 Toyota Cup games for the Junior Warriors, scoring thirty seven tries.
In 2010 he trained during the pre-season with the senior side and was named to make his first grade début for the Warriors on 4 April 2010 against the Manly-Warringah Sea Eagles.
In 2010 he was picked for the Junior Kiwis.
In the 2011 NRL season, Tupou played 17 games for the New Zealand Warriors as the club reached the 2011 NRL Grand Final. Tupou played on the wing in the club's loss against Manly-Warringah.
On 12 October 2011 he was called into the New Zealand national rugby league team squad for the Four Nations tournament.
In 2012, Tupou re-signed with the New Zealand Warriors until the end of the 2014 NRL season.
Tupou joined Canberra on 25 June 2013. He had felt as though he was on the outer with the New Zealand Warriors under new coach Matt Elliot who had preferred others to him on the wing during the 2013 season.
Tupou joined Wakefield Trinity in July 2015 and was well known by Wakefield Trinity fans and Super League fans alike for his aggressive and fearless style of play as a powerful centre. Tupou scored a memorable eleventh-minute hat trick in Wakefield's 42–30 win away at Wigan. On 16 June 2021 he ruptured his patella tendon, resulting in surgery ending his 2021 campaign. Tupou announced on 5 July 2022 he would retire immediately due to complications from the previous injury.
References
External links
Wakefield Trinity profile
NRL profile
New Zealand Warriors profile
SL profile
1990 births
Living people
Auckland rugby league team players
Bay Roskill Vikings players
Canberra Raiders players
Junior Kiwis players
Marist Saints players
Mount Pritchard Mounties players
New Zealand national rugby league team players
New Zealand sportspeople of Tongan descent
New Zealand expatriate sportspeople in England
New Zealand expatriate sportspeople in Australia
New Zealand rugby league players
New Zealand Warriors players
Rugby league centres
Rugby league players from Auckland
Rugby league wingers
Tonga national rugby league team players
Tongan rugby league players
Wakefield Trinity players
|
Şuvaş (also, Shuash and Shuvash) is a village in the Astara Rayon of Azerbaijan. The village forms part of the municipality of Səncərədi.
References
Populated places in Astara District
|
HMS Asphodel was a that served in the Royal Navy and was built by George Brown and Company in 1940. She was named after Asphodel. Commissioned in 1940 and sunk by on 10 March 1944.
Design and description
In early 1939, with the risk of war with Nazi Germany increasing, it was clear to the Royal Navy that it needed more escort ships to counter the threat from Kriegsmarine U-boats. One particular concern was the need to protect shipping off the east coast of Britain. What was needed was something larger and faster than trawlers, but still cheap enough to be built in large numbers, preferably at small merchant shipyards, as larger yards were already busy. To meet this requirement, the Smiths Dock Company of Middlesbrough, a specialist in the design and build of fishing vessels, offered a development of its 700-ton, whale catcher Southern Pride. They were intended as small convoy escort ships that could be produced quickly and cheaply in large numbers. Despite naval planners' intentions that they be deployed for coastal convoys, their long range meant that they became the mainstay of Mid-Ocean Escort Force convoy protection during the first half of the war. The original Flowers had the standard RN layout, consisting of a raised forecastle, a well deck, then the bridge or wheelhouse, and a continuous deck running aft. The crew quarters were in the foc'sle while the galley was at the rear, making for poor messing arrangements.
The modified Flowers saw the forecastle extended aft past the bridge to the aft end of the funnel, a variation known as the "long forecastle" design. Apart from providing a very useful space where the whole crew could gather out of the weather, the added weight improved the ships' stability and speed and was retroactively applied to a number of the original Flower-class vessels during the mid and latter years of the war.
Construction and career
Asphodel was laid down by George Brown and Company at their shipyard at Greenock, on 20 October 1939 and launched on 25 May 1940. She was commissioned on 11 September 1940.
HMS Asphodel was escorting convoy SL-150 with combination of MKS-41 off Cape Finisterre. launched a torpedo which struck the Asphodel and escaped soon after. Only 5 sailors from Asphodel were rescued by HMS Clover while 92 others went down with Asphodel.
References
Sources
Flower-class corvettes of the Royal Navy
1940 ships
Ships sunk by German submarines in World War II
World War II shipwrecks in the Atlantic Ocean
Ships build by George Brown and Company
|
```javascript
Most efficient way to build `HTML` strings
Use `splice()` to remove an item from an array
Counting the months from zero
NaN === NaN?
`NaN` is a number
```
|
Georgi Andonov (; born 28 June 1983 in Plovdiv) is a Bulgarian footballer who plays as a forward.
Career
Andonov's first club was Botev Plovdiv. With Botev he played 112 games and scored 12 goals.
In 2006, Cherno More Varna signed Andonov to a four-year deal for a €100,000. During a 2008–09 season, after a few poor performances along with the impressive form of Miroslav Manolov and Yordan Yurukov, Andonov found regular starting positions in attack hard to find. In January 2009, he was loaned in his previously club Botev to the end of the season.
On 3 July 2009, Andonov signed a contract with Beroe Stara Zagora.
In May 2010 Andonov signed a two-year deal with Chernomorets Burgas.
In February 2012, Andonov was released from his contract and returned to Beroe Stara Zagora as a free agent. He scored a hat-trick in the opening game of the 2012–13 season against Botev Vratsa on 11 August. On 15 May 2013, Andonov led Beroe out as captain in the 2013 Bulgarian Cup Final, which they won 6–4 after penalties against Levski Sofia, as Andonov collected his second Bulgarian Cup winner's medal.
On 12 June 2018, Andonov signed with Second League club Arda.
In May 2021, Andonov moved to Asenovets.
Honours
Club
Beroe Stara Zagora
Bulgarian Cup (2): 2009–10, 2012–13
Bulgarian Supercup (1): 2013
References
External links
Bulgarian men's footballers
1983 births
Living people
Footballers from Plovdiv
Men's association football forwards
First Professional Football League (Bulgaria) players
Second Professional Football League (Bulgaria) players
TFF First League players
Botev Plovdiv players
PFC Cherno More Varna players
PFC Beroe Stara Zagora players
PSFC Chernomorets Burgas players
Denizlispor footballers
FC Vereya players
FC Arda Kardzhali players
FC Tsarsko Selo Sofia players
FC Hebar Pazardzhik players
FC Levski Karlovo players
Bulgarian expatriate men's footballers
Expatriate men's footballers in Turkey
Bulgarian expatriate sportspeople in Turkey
|
The Egypt Medal is a campaign medal that was awarded by the Governor-General of India to members of the expeditionary force that travelled from India to take part in the 1801 Egyptian campaign, a part of the French Revolutionary Wars.
Criteria
The medal was awarded to the soldiers of the Major General Baird's division, comprising both East India Company (EIC) and British Army units, that sailed from Bombay to Egypt in March 1801 to take part in the campaign against the French. After being present at the successful sieges of Cairo in June, and Alexandria in August and September, the division returned to India in early 1802.
The medal was authorised in July 1802 by Marquess Wellesley, the Governor-General of India, although the medals were only finally completed and distributed from 1811. Troops from Bengal received the medal in gold for more senior officers (16 awarded) and in silver for other ranks (760 awarded), while all members of the Bombay contingent were issued with silver medals (1,439 awarded).
Only those who sailed from India with General Baird's division were entitled to the medal, including those who did not reach Egypt. Others, including members of the 61st Foot who joined the division in Egypt, having travelled from the Cape of Good Hope, were ineligible. Surviving British Army and Royal Navy Egypt veterans who had not received the earlier Egypt Medal were however eligible for either the Military or Naval General Service Medal with clasp Egypt when this clasp was authorised in 1850.
Description
The medal was engraved and struck at the Calcutta Mint in gold and in silver. Both types were in diameter with the following design:
The obverse depicts a sepoy holding a Union Jack with an encampment in the background. Below is the Persian inscription This medal has been presented in commemoration of the defeat of the French armies in the Kingdom of Egypt by the great bravery of the victorious army of England.The reverse shows a ship of the line under full sail towards the Egyptian coast, with an obelisk and four pyramids in the background. In the exergue is the date MDCCCI (1801).The medal was issued unnamed.The suspension is a flattened loop, pinned at the base, through which passes a yellow suspension cord allowing the medal to be worn around the neck.
Specimens in bronze and bronze gilt are later strikings and were not issued.
References
External links
British Army Medals: Egypt Medal, 1801
British campaign medals
Medals of the Honourable East India Company
Awards established in 1802
British military medals of the Napoleonic Wars
French campaign in Egypt and Syria
|
```smalltalk
namespace ReClassNET.MemoryScanner.Comparer
{
public interface IScanComparer
{
ScanCompareType CompareType { get; }
}
}
```
|
Al-Mu'ayyad Muhammad (1582 – September 1644) was an Imam of Yemen (1620–1644), son of Al-Mansur al-Qasim. He managed to expel the Ottoman Turks entirely from the Yemenite lands, thus confirming an independent Zaidi state.
Succeeding to the imamate
Muhammad was the son of Imam al-Mansur al-Qasim who restored the Zaidi imamate and began the cumbersome process of conquering back Yemen from the Ottoman occupiers. When he took the reins of government from his father in 1620, much of the highland was in Zaidi hands, and there was an uneasy truce with the Turks. In 1622 the population in and around Sa'dah in the north refused to pay taxes to the imam. Muhammad then sent his brother Saif al-Islam al-Hasan who put down the revolt. Al-Hasan, however, found means to win the confidence of the locals through reforms, and was appointed governor on behalf of the imam. Through this act of delegation of power to a relative, the power of the Qasimid family was confirmed in the north. In 1626, Muhammad conquered Jabal Fayfa east of Abu Arish. In the same year he decided to break the truce with the Ottomans after the latter had executed one of his ulemas who had gone to the Turkish-controlled San'a. The tribes of northern Yemen responded enthusiastically to his call. The sharifs of the Sulaymanid province of northern Tihamah and the amirs of Kawkaban supported Muhammad. The rising scored victories against Turkish troops. Most of the lowland area of Tihamah fell to the imam's forces, and San'a was besieged. The Ottoman difficulties were aggravated by the attacks of Shah Abbas the Great on Turkish positions in Iraq.
Expulsion of the Ottomans
In 1629 Imam al-Mu'ayyad Muhammad proposed a truce with the Ottomans, as he saw the need to rest his own forces. The governor Haydar Pasha agreed, and on 9 March 1629 he handed over the keys to San'a to the imam's son Ali. The Turks withdrew to the coast under the imam's protection, and another son, Yahya, was made governor (amil) of San'a. Yet a major city, Ta'izz, fell in the same year. In 1635 the Turks took to the offensive with an augmented force, but were defeated. Now they finally gave in, agreeing to surrender the lowland cities Zabid, and Mocha, and Kamaran Island. Thus the first period of Ottoman rule in Yemen was at an end.
Governance and personality
Al-Mu'ayyad Muhammad spent most of his reign fighting the Ottomans, as well as bringing a degree of unity among the various tribal groups of Yemen. In this work he was assisted by his able brothers al-Hasan (d. 1639), al-Husayn (d. 1640) and Ahmad (d. 1650). Ahmad was the ancestor of a line of hereditary lords of Sa'dah which sometimes opposed the authority of the imams. The imam's own son al-Qasim headed a dynastic branch that governed Shahara. Al-Mu'ayyad Muhammad was also a writer of note. Thirteen texts by his hand have been preserved, many of them legal opinions and interpretations that are based on Zaidi dogma. He declined to enforce some aspects of the shariah on society, since this could have aleniated his tribal supporters. At his death, al-Mu'ayyad Muhammad was succeeded by his brother al-Mutawakkil Isma'il, though not without fraternal strife among contenders.
See also
Imams of Yemen
History of Yemen
Zaydiyyah
References
Further reading
R.L. Playfair, A History of Arabia Felix or Yemen. Bombay 1859.
Michel Tuchscherer, 'Chronologie du Yémen (1506-1635)', Chroniques yémenites 8 2000, http://cy.revues.org/11
Zaydi imams of Yemen
1582 births
1644 deaths
16th-century Arab people
17th-century Arab people
|
```html
<!DOCTYPE html>
<html xmlns="path_to_url"><head><title>Siso (owl-base.Owl_algodiff_ops_builder_sig.Sig.Siso)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../index.html">owl-base</a> » <a href="../../index.html">Owl_algodiff_ops_builder_sig</a> » <a href="../index.html">Sig</a> » Siso</nav><header class="odoc-preamble"><h1>Module type <code><span>Sig.Siso</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-label"><a href="#val-label" class="anchor"></a><code><span><span class="keyword">val</span> label : string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ff_f"><a href="#val-ff_f" class="anchor"></a><code><span><span class="keyword">val</span> ff_f : <span><a href="../index.html#type-elt">elt</a> <span class="arrow">-></span></span> <a href="../index.html#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ff_arr"><a href="#val-ff_arr" class="anchor"></a><code><span><span class="keyword">val</span> ff_arr : <span><a href="../index.html#type-arr">arr</a> <span class="arrow">-></span></span> <a href="../index.html#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-df"><a href="#val-df" class="anchor"></a><code><span><span class="keyword">val</span> df : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <a href="../index.html#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-dr"><a href="#val-dr" class="anchor"></a><code><span><span class="keyword">val</span> dr : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><span><a href="../index.html#type-t">t</a> <span class="xref-unresolved">Stdlib</span>.ref</span> <span class="arrow">-></span></span> <a href="../index.html#type-t">t</a></span></code></div></div></div></body></html>
```
|
```xml
import {
Column,
Entity,
PrimaryGeneratedColumn,
TableInheritance,
} from "../../../../src"
@Entity()
@TableInheritance({ column: { type: String, name: "type" } })
export class Contact {
@PrimaryGeneratedColumn()
id: number
@Column()
userId: number
@Column()
value: string
}
```
|
Ilya Sachkov (Илья Сачков) is a Russian cybersecurity expert and founder and CEO of Group-IB, a cybersecurity company specialising in the detection and prevention of cyberattacks. He received an award from Russian President Vladimir Putin for his work in 2019. In September 2021, he was detained by the Russian government's Federal Security Service on treason charges.
According to Bloomberg News, he is alleged to have provided the U.S. government with information about the Russian government's "Fancy Bear" operation that sought to influence the 2016 United States presidential election.
Career
Sachkov started Group-IB at age 17 while studying at the Bauman Moscow State Technical University, and according to the Financial Times, "attempted to build a global business while remaining on the good side of the Russian government."
In June, 2017, Sachkov was appointed a Commissioner in the Global Commission on the Stability of Cyberspace, an international multistakeholder commission to develop diplomatic norms against national cyber-attacks. He served until the commission's successful conclusion in November, 2019.
Views on Russian government handling of cybercrime
In a panel with Russian prime minister Mikhail Mishustin in attendance, Sachkov criticised the Russian government's response to ransomware attacks emanating from Russia, pointing to Maksim Yakubets as an example. Sachkov's criticism of the Russian government's apparent tolerance of some online criminals continued until late until his arrest by the FSB in September 2021.
Detention and conviction on treason charges
In a statement released by his lawyer to Forbes Russia in November 2021, Sachkov rejected the treason charges saying he is "neither a traitor nor a spy" and appealed to Putin to move him to house arrest while he awaits trial, after his detention was extended by three months. Russian businessman Boris Titov called for answers in a Facebook post, saying "It is necessary for investigators to explain themselves", otherwise it would deal a "critical blow" to the sector. Russian state news agency TASS said the case materials are "classified" and "no further details are available." In June 2023, the case was transferred to the Moscow City Court for consideration on the merits.
Group-IB co-founder Dmitry Volkov who took over as chief executive said the company did not know what Sachkov had been charged with and was convinced of his innocence. Volkov said that since all case materials are classified, it "provides fertile ground for rumours and speculations", saying that without access to those materials "making any assumptions or promoting any versions would be wrong."
According to Russian news outlet RBC, a lawyer for Sergei Mikhailov, a former FSB cyber official convicted of treason, Sachkov gave false testimony which led to the conviction.
According to Bloomberg News, Sachkov was alleged to have provided information to western intelligence agencies about Vladislav Klyushin, a founder of another cybersecurity company, who was arrested in Switzerland in March 2021.
On July 25, the Moscow court sentenced Sachkov to "14 years in prison." The sentence was a reduction from the state prosecutor's original request for an 18-year sentence and was delivered during an in camera session.
See also
Fancy Bear
Ransomware
References
Living people
People in information technology
Chief executives of computer security organizations
Computer security specialists
Commissioners of the Global Commission on the Stability of Cyberspace
Prisoners and detainees of Russia
Year of birth missing (living people)
People associated with Russian interference in the 2016 United States elections
|
Robert Sivell (1888–1958) was a Scottish portrait artist active in the first half of the 20th century. He was a founder member of the Glasgow Society of Artists and Sculptors in 1919.
Biography
Sivell was born in Paisley, Renfrewshire, but lived in Kirkcudbright, Galloway for long periods of his adult life.
While beginning evening studies at the Glasgow School of Art with Fra Newbery in 1908, Sivell was still working as an apprentice engineer and he had to abandon the art course in 1910. He lacked the means to attend school full time. In 1912 he travelled to Canada and also visited Paris and Florence, but he returned to Scotland in 1914 as the country readied for war, using his engineering skills to fit out trawlers and drifters for mine-sweeping and other operations. He also worked on the Boom Defence of Cromarty. In 1916 he joined the Merchant Navy. When he left it, Sivell moved to Glasgow, where he could paint evenings and weekends, sharing a studio with Archibald McGlashon.
Sivell met Isobel Sayers from Kirkcudbright while she was visiting Glasgow; they married in 1923. They rented a bungalow on the River Dee across from Kirkcudbright. They had one child, a daughter, Elspeth Dolores. The couple moved to Kirkcudbright at some point after 1924, building a house and studio at The Hollow, Stell.
Together with James Cowie and Archibald McGlashan, Sivell was a founder member of the Glasgow Society of Artists and Sculptors in 1919. Their exhibitions took place at the McLellan Galleries and attracted some controversy over the exclusion of work by non-members. Sivell travelled at some point in those years to Italy, which had a strong influence on his work.
In the 1930s Sivell moved to Aberdeen to teach at Grays School of Art, serving as Head of Drawing and Painting from 1942 to 1954. His pupils included Joe Edwards, Taylor Bremner, Gordon Stewart Cammeron, and Alberto Morrocco, who built up a large collection of Sivell's work. In 1936 he was elected an Associate of the Royal Scottish Academy (ARSA) and in 1943 a full member (RSA). While at Gray's, he undertook a large-scale painting project consisting of larger-than-life murals in a lecture and exhibition hall within the Aberdeen University Union on Gallowgate. This project involved two of his pupils (Albert Morrocco and Gordon S Cameron) in an effort that began in 1938 and continued until his retirement in 1953, being interrupted by World War II. During the war Sivell completed a number of short-term commissions for the War Artists Advisory Committee. Among these was one of a Scottish policeman and two of women who had both been awarded the George Medal. During his years of teaching, Sivell continued to paint commissioned portraits and subjects of his own choosing, and to exhibit in galleries and exhibitions.
Sivell retired in 1954 and returned to Kirkcudbright, where he died in 1958. He and his wife, Isobel (died 1962), were buried on the slope behind his home and studio, The Hollow, Stell, according to their wishes.
Memorials
The Aberdeen Students' Union, where his murals stand, was named Sivell's Bar in his memory. After Aberdeen University sold the building, the murals were given historic status and protection by the city, but they have been inaccessible to the public for many years, with the building and murals listed "at risk" in the Buildings At Risk Register for Scotland. Sivell was sculpted by his friend Benno Schotz, and while photos of this bust exist, its current location and condition are unknown. In 1960 the Arts Council Scottish Committee held a memorial exhibition of his work in Edinburgh.
Public works
At least 120 paintings by Sivell are held in Aberdeen art Museum, a large number having been donated by Alberto Morrocco. Many of his portraits are executed in oil on wood and have a dark and foreboding tone.
Wall murals, Aberdeen University Student Union, Gallowgate (1938–40)
Studies for mural including The Grape Harvest, Pastoral, Medical and The Creation, Aberdeen Art Gallery
Elspeth (his daughter), Aberdeen Art Gallery
Dawn, Aberdeen Art Gallery
Noon, Aberdeen Art Gallery
Bathers, Aberdeen Art Gallery
Portrait of Francis Garden, Aberdeen Art Gallery
Portrait of a Soldier (Pt Alistair Paterson), Aberdeen Art Gallery
Mrs Marion Patterson, recipient of the George Medal, Imperial War Museum, London
Woman in a Shawl, Glasgow Museums
Dehydration of Herrings, Glasgow Museums
Sisters, National Museum of Northern Ireland
Eve, City of Edinburgh Council
Captain Benjamin Bryant, Aberdeen Art Gallery
Spring, Aberdeen Art Gallery
Family Group, Aberdeen Art Gallery
Senorita, Perth & Kinross Council
The Cello Player, Aberdeen Art Gallery
Coats Memorial Church, Paisley Art Gallery
The Twins of Craigie Hall, Paisley Art Gallery
Phyllis Bone, Gracefield Collection, Kirkcudbright
Study of Sir George Pirie
The Provost, Kirkcudbright Tolbooth Art Centre
The Drawing Book, McLean Museum and Art Gallery
Lamont in Lamplight (unfinished) (1958)
References
External links
War Art in Canada: A Critical History, by Laura Brandon published by the Art Canada Institute.
Artist's website
1888 births
1958 deaths
20th-century Scottish painters
Academics of Robert Gordon University
British Merchant Service personnel of World War I
British war artists
People from Kirkcudbright
Royal Scottish Academicians
Scottish male painters
World War II artists
20th-century Scottish male artists
Guthrie Award winners
Alumni of the Glasgow School of Art
Academics of Gray's School of Art
|
```php
<?php
/*
*
*
* path_to_url
*
* Unless required by applicable law or agreed to in writing, software
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata extends \Google\Model
{
/**
* @var string
*/
public $createTime;
/**
* @var string
*/
public $failureCount;
/**
* @var string
*/
public $successCount;
/**
* @var string
*/
public $updateTime;
/**
* @param string
*/
public function setCreateTime($createTime)
{
$this->createTime = $createTime;
}
/**
* @return string
*/
public function getCreateTime()
{
return $this->createTime;
}
/**
* @param string
*/
public function setFailureCount($failureCount)
{
$this->failureCount = $failureCount;
}
/**
* @return string
*/
public function getFailureCount()
{
return $this->failureCount;
}
/**
* @param string
*/
public function setSuccessCount($successCount)
{
$this->successCount = $successCount;
}
/**
* @return string
*/
public function getSuccessCount()
{
return $this->successCount;
}
/**
* @param string
*/
public function setUpdateTime($updateTime)
{
$this->updateTime = $updateTime;
}
/**
* @return string
*/
public function getUpdateTime()
{
return $this->updateTime;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata::class, your_sha256_hashtCompletionSuggestionsMetadata');
```
|
549 Lordship Lane, also known as the Concrete House, is a house on Lordship Lane in East Dulwich, close to the junction with Underhill Road and opposite St Peter's Church. The Gothic Revival house is an early example of a modern domestic dwelling constructed of concrete. It became a grade II listed building in 1994.
The house may have been designed by Charles Barry Jr. (1823-1900) (son of Sir Charles Barry who worked on the Houses of Parliament), possibly as a rectory or parsonage to accompany his Gothic style St Peter's Church on the opposite other side of Lordship Lane. It was built in 1873 by Charles Drake of the Patent Concrete Building Company, and it may have been his own house. Drake had taken out a patent in 1867 for the use of iron panels for shuttering, in place of the usual timber. The mass concrete construction anticipates modern slip form methods, with bare concrete around the windows resembling stone, and surface patterning in other areas resembling pebbledash, with an effect similar to béton brut. It is believed that the house is the only surviving example in England.
It was made from Portland cement with "burnt ballast" (clay) aggregate, without reinforcement, faced with mortar and render. The house has an L-shape plan, with two storeys and an attic. The ground floor has canted bays on the two principal façades, to the south west and south east, with pointed arched windows, and gabled porch in the return angle on the south west elevation. There are further pointed arched windows on the first floor, and square headed windows on the north west and north east elevations. The steeply pitched slate roof has projecting gables, topped by three large concrete chimneys.
The house was sold three years after it was completed, and passed through many hands of many owners. It suffered bomb damage in the Second World War, but survived plans to replace it in the 1950s with a petrol filling station or residential flats, or in the 1970s with a nursery, or in the 1980s with a nursing home. It fell into disrepair and was vacant from the 1980s, with water ingress through holes in the roof causing significant damage to the interior, including the loss of the original decorative cornices and ceiling roses.
The owner was granted planning permission to construct a similar building behind, on condition that the Concrete House was restored, but while the new building was completed the restoration was not done, and the house became increasingly dilapidated. Southwark London Borough Council rejected several applications for permission to demolish the building. It was listed on English Heritage's Buildings At Risk register from 1994 to 2013.
The house was acquired by Southwark Council in 2009 under a compulsory purchase order. It was restored with assistance from the Heritage of London Trust, the Architectural Heritage Fund, and the London Development Agency, and converted from a single dwelling into five flats in shared ownership, with a long lease granted to Hexagon Housing Association. Prince Richard, Duke of Gloucester, reopened the restored building on 13 June 2013.
The restoration won the Angel Commendation award from English Heritage in 2013, and an award for building conservation from the Royal Institution of Chartered Surveyors in 2014.
References
Number 549 and gate piers, National Heritage List for England, Historic England
A gothic house made from concrete, ianvisits.co.uk, 22 August 2019
The Concrete House Restoration by Paul Latham, The Dulwich Society, 25 September 2013
The Concrete House, 549 Lordship Lane, The Dulwich Society, 14 June 2013
Newsletter, The Dulwich Society, 25 June 2009
549 Lordship Lane, Heritage of London Trust Operations
Restoring Charles Drake's concrete house, Paul Latham, Institute of Historic Building Conservation, 8 September 2016
549 Lordship Lane, London, Architectural Heritage Fund, 20 November 2018
External links
Catalogue of Drake's Patent Concrete Building Company, archive.org
Concrete buildings and structures
Grade II listed buildings in the London Borough of Southwark
Grade II listed houses in London
Houses completed in 1873
Dulwich
|
Zachkan (, also Romanized as Zāchkān; also known as Zaikān, Zājkān, Zāj Kand, Zāj Kandī, Z̄āker, and Zaykan) is a village in Chavarzaq Rural District, Chavarzaq District, Tarom County, Zanjan Province, Iran. At the 2006 census, its population was 195, in 56 families.
References
Populated places in Tarom County
|
```php
<?php
/*
*
*
* path_to_url
*
* Unless required by applicable law or agreed to in writing, software
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
*/
namespace Google\Service\ShoppingContent;
class DatafeedStatusError extends \Google\Collection
{
protected $collection_key = 'examples';
/**
* @var string
*/
public $code;
/**
* @var string
*/
public $count;
protected $examplesType = DatafeedStatusExample::class;
protected $examplesDataType = 'array';
/**
* @var string
*/
public $message;
/**
* @param string
*/
public function setCode($code)
{
$this->code = $code;
}
/**
* @return string
*/
public function getCode()
{
return $this->code;
}
/**
* @param string
*/
public function setCount($count)
{
$this->count = $count;
}
/**
* @return string
*/
public function getCount()
{
return $this->count;
}
/**
* @param DatafeedStatusExample[]
*/
public function setExamples($examples)
{
$this->examples = $examples;
}
/**
* @return DatafeedStatusExample[]
*/
public function getExamples()
{
return $this->examples;
}
/**
* @param string
*/
public function setMessage($message)
{
$this->message = $message;
}
/**
* @return string
*/
public function getMessage()
{
return $this->message;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DatafeedStatusError::class, 'Google_Service_ShoppingContent_DatafeedStatusError');
```
|
Stephen Samuel Stratton (19 December 1840 – 25 June 1906) was an English music critic, organist and author.
Life
He was born in London on 19 December 1840. He was a chorister at St. Mary's Church, Ealing and studied music under Charles Lucas.
He arrived in Birmingham in 1866 and became music critic to the Birmingham Post in 1877, holding the post until his death. He was also a frequent contributor to the London Musical Press. He was the joint author with James Duff Brown of British Musical Biography published in 1897.
Appointments
Organist of St. Mary the Virgin, Soho, London
Organist of St. James' Church, Friern Barnet
Organist of St Bartholomew's Church, Edgbaston, Birmingham 1867 - 1875
Organist of St. John's Church, Harborne 1875 - 1878
Organist of the Church of the Saviour, Birmingham 1878 - 1882
Publications
British Musical Biography, with James Duff Brown
The Life of Mendelssohn
Nicolo Paganini: His Life and Work
References
External links
1840 births
1906 deaths
English organists
British male organists
English composers
19th-century English musicians
19th-century British male musicians
19th-century organists
English music critics
Classical music critics
|
```css
Default to a transparent `border-color` before adding a border to on `:hover` state elements
At-Rules (`@`)
Use `:not()` to apply/unapply styles
Use `SVG` for icons
Combining selectors
```
|
Gaius Antistius Vetus was a Roman politician and general who was consul suffectus in 30 BC as the colleague of Augustus, succeeding Marcus Licinius Crassus.
Biography
Vetus was a descendant of the Plebeian Roman house of the Antistii Veteres. He was probably the son of Gaius Antistius Vetus, praetor in 70, and governor in 69 BC in Hispania Ulterior, under whom Julius Caesar served as quaestor.
Initially a supporter of Caesar, Vetus was appointed Quaestor pro praetore of Syria by Caesar, a position which he held in 45 BC. He was forced to fight against Quintus Caecilius Bassus, the former governor and an opponent of Caesar, who refused to relinquish his post. Vetus besieged him until the Parthians came to relieve Bassus; during this time Vetus was hailed as imperator.
On his way back to Rome in 44 BC, he was intercepted by Brutus, one of Caesar's leading assassins, who persuaded him not only to hand over the province's revenues which he was taking to Rome, but also to join the cause of the Liberatores. In June 43 BC he was back in Rome but soon returned to Brutus where he served as one of his legates. Fleeing after the defeat of Brutus at Philippi, Vetus eventually became reconciled with Marcus Antonius and Octavianus.
In 35 BC, Vetus was given command of the ongoing war against the Salassi, perhaps as the governor of Transalpine Gaul, which he prosecuted with vigour, but without success. Then in 30 BC, he was awarded the position of consul suffectus, serving alongside Octavianus for a portion of the year. Vetus was then made legate of Hispania Citerior in 26 BC, one of the few men of consular standing to be given a military province during the reign of Augustus. He took over from Augustus after the Princeps fell ill whilst on campaign in Spain, leading a campaign together with P. Carusius against the Astures which they successfully concluded in 25 BC.
His son, Gaius Antistius Vetus, served as consul in 6 BC. Two of his grandsons also went on to become consuls.
See also
Antistia gens
Sources
T. Robert S. Broughton, The Magistrates of the Roman Republic, Vol II (1952).
Syme, Ronald, The Roman Revolution, Clarendon Press, Oxford, 1939.
Anthon, Charles & Smith, William, A New Classical Dictionary of Greek and Roman Biography, Mythology and Geography (1860).
Notes
1st-century BC Roman governors of Syria
1st-century BC Romans
Vetus, Gaius (consul 724 AC)
Imperial Roman consuls
|
Mukri is a village in Kehtna Parish, Rapla County in northern-central Estonia.
References
Villages in Rapla County
|
René Spicher (born 6 March 1963) is a retired Swiss footballer who played in the late 1980s and early 1990s. He played as defender or as midfielder.
Spicher first played two seasons with BSC Old Boys in the Nationalliga B, the second tier of Swiss football. In both seasons he played regularly in the teams starting 11.
Spicher then joined FC Basel's first team for their 1989–90 season under head-coach Urs Siegenthaler, also in the second tier of Swiss football. After playing in two test matches, Spicher played his domestic league debut for his new club in the home game at the St. Jakob Stadium on 22 July 1989 as Basel won 2–0 against his old club Old Boys. Spicher scored his first goal for his club on 23 August in the away game as Basel played a 2–2 draw with Chênois.
He stayed with the club only this one season and during this time Spicher played a total of 12 games for Basel scoring that one goal. 8 of these games were in the Nationalliga A, two in the Swiss Cup and two were friendly games.
References
Sources
Die ersten 125 Jahre. Publisher: Josef Zindel im Friedrich Reinhardt Verlag, Basel.
Verein "Basler Fussballarchiv" Homepage
BSC Old Boys players
FC Basel players
Swiss men's footballers
Men's association football defenders
Men's association football midfielders
1963 births
Living people
Swiss Challenge League players
|
Talbotia may refer to:
Talbotia (plant), a monotypic genus of monocotyledonous flowering plants
Pieris (butterfly) or Talbotia, a genus of butterflies
|
"The Dolphins" is a song written and recorded by American singer-songwriter Fred Neil and released in 1967. Writer Mark Brend described the song's lyrics as "ambivalent and elusive".
The song was frequently performed by Tim Buckley, who had been present during the song's recording. The song has also been recorded by Billy Bragg, Beth Orton, and Dave Alvin with The Third Mind.
References
1967 songs
American folk songs
Songs written by Fred Neil
|
Christopher Selby Austin Dobson (25 August 1916 – 22 December 2005) was an English librarian who was the librarian of the House of Lords Library from 1956 to 1977.
Early life and education
Dobson was born in 1916 in Isleworth to Alban Tabor Austin Dobson (1885–1962), a civil servant, and Katharine Jean Selby Dobson. His father managed the literary estate of his own father, the poet and essayist Austin Dobson.
Dobson grew up in Ealing. He was educated at Clifton College in Bristol and Emmanuel College, Cambridge.
During the Second World War, he served in The Middlesex Regiment and was mentioned in dispatches, rising to the rank of lieutenant.
Career
In 1947, Dobson became assistant to House of Lords Library librarian Charles Travis Clay, who had been in the post since 1914.
Under Clay's guidance, Dobson compiled an edition of the Oxfordshire Protestation Returns 1641–1642, published in 1955, and organised the legal collections. However, Dobson lacked passion for statistics and historical research, far preferring the literary world.
Following Clay's retirement in 1956, Dobson succeeded him and maintained the library largely as his predecessors had, with the library acquiring about 250 titles per year. At this time, there was little impetus for modernisation of library standards. Dobson's main interest was in the acquisition of rare and historical volumes, and grew the library's collection of works from the reigns of Henry VIII through William and Mary.
In 1960, he and Earl Spencer edited Letters of David Garrick and Georgiana Countess Spencer, 1759–1779.
He was described in The Times as:
He retired in 1977 as the need for drastic change became apparent, owing to technology advances and the growing numbers of life peers who had larger research demands than their hereditary counterparts. He was succeeded by Roger Morgan, who saw the library through a period of modern transformation of increasing digitisation, from 1977 to 1991.
In 1964, he became a member of the Roxburghe Club for bibliophiles. He had a considerable private collection of books and was an enthusiast of Victorian bindings.
Dobson was appointed a Commander of the Order of the British Empire (CBE) in the 1976 New Year Honours.
In 1941, he married Helen Broughton Turner, and had a son and a daughter. He died in December 2005 in Cambridge, Cambridgeshire.
References
1916 births
2005 deaths
People from Ealing
English librarians
People educated at Clifton College
Alumni of Emmanuel College, Cambridge
Commanders of the Order of the British Empire
|
```objective-c
/* wmem_user_cb_int.h
* Definitions for the Wireshark Memory Manager User Callback Internals
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
*
* This program is free software; you can redistribute it and/or modify
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
*
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef __WMEM_USER_CB_INT_H__
#define __WMEM_USER_CB_INT_H__
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
#include <glib.h>
#include "wmem_user_cb.h"
WS_DLL_LOCAL
void
wmem_call_callbacks(wmem_allocator_t *allocator, wmem_cb_event_t event);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* __WMEM_USER_CB_INT_H__ */
/*
* Editor modelines - path_to_url
*
* Local variables:
* c-basic-offset: 4
* tab-width: 8
* indent-tabs-mode: nil
* End:
*
* vi: set shiftwidth=4 tabstop=8 expandtab:
* :indentSize=4:tabSize=8:noTabs=true:
*/
```
|
```go
/*
*/
package blocksprovider
import (
"sync"
"time"
"github.com/hyperledger/fabric-lib-go/common/flogging"
"github.com/hyperledger/fabric-protos-go/common"
"github.com/hyperledger/fabric-protos-go/orderer"
"github.com/hyperledger/fabric/protoutil"
"github.com/pkg/errors"
)
// BFTHeaderReceiver receives a stream of blocks from an orderer, where each block contains a header and metadata.
// It keeps track of the last header it received, and the time it was received.
// The header receivers verify each block as it arrives.
//
// The header receiver receives full config blocks.
// The header receiver maintains its own private block verifier that gets updated on every config block.
type BFTHeaderReceiver struct {
mutex sync.Mutex
chainID string
stop bool
stopChan chan struct{}
started bool
errorStopTime time.Time
endpoint string
client orderer.AtomicBroadcast_DeliverClient
updatableBlockVerifier UpdatableBlockVerifier
// A block with Header & Metadata, without Data (i.e. lastHeader.Data==nil); except from config blocks, which are full.
lastHeader *common.Block
// The time lastHeader was received, or time.Time{}
lastHeaderTime time.Time
logger *flogging.FabricLogger
}
// NewBFTHeaderReceiver create a new BFTHeaderReceiver.
//
// If the previousReceiver is not nil, the lastHeader and lastHeaderTime are copied to the new instance.
// This allows a new receiver to start from the last know good header that has been received.
func NewBFTHeaderReceiver(
chainID string,
endpoint string,
client orderer.AtomicBroadcast_DeliverClient,
updatableBlockVerifier UpdatableBlockVerifier,
previousReceiver *BFTHeaderReceiver,
logger *flogging.FabricLogger,
) *BFTHeaderReceiver {
hRcv := &BFTHeaderReceiver{
chainID: chainID,
stopChan: make(chan struct{}, 1),
endpoint: endpoint,
client: client,
updatableBlockVerifier: updatableBlockVerifier.Clone(),
logger: logger,
}
if previousReceiver != nil {
block, bTime, err := previousReceiver.LastBlock()
if err == nil {
hRcv.lastHeader = block
hRcv.lastHeaderTime = bTime
}
}
return hRcv
}
// DeliverHeaders starts to deliver headers from the stream client
func (hr *BFTHeaderReceiver) DeliverHeaders() {
var normalExit bool
defer func() {
if !normalExit {
hr.mutex.Lock()
hr.errorStopTime = time.Now()
hr.mutex.Unlock()
}
_ = hr.Stop()
hr.logger.Debugf("[%s][%s] Stopped to deliver headers", hr.chainID, hr.endpoint)
}()
hr.logger.Debugf("[%s][%s] Starting to deliver headers", hr.chainID, hr.endpoint)
hr.setStarted()
for !hr.IsStopped() {
msg, err := hr.client.Recv()
if err != nil {
hr.logger.Debugf("[%s][%s] Receive error: %s", hr.chainID, hr.endpoint, err.Error())
return
}
switch t := msg.GetType().(type) {
case *orderer.DeliverResponse_Status:
if t.Status == common.Status_SUCCESS {
hr.logger.Warningf("[%s][%s] Warning! Received %s for a seek that should never complete", hr.chainID, hr.endpoint, t.Status)
return
}
hr.logger.Errorf("[%s][%s] Got bad status %s", hr.chainID, hr.endpoint, t.Status)
return
case *orderer.DeliverResponse_Block:
blockNum := t.Block.Header.Number
if !protoutil.IsConfigBlock(t.Block) { // normal blocks with block.Data==nil
err := hr.updatableBlockVerifier.VerifyBlockAttestation(t.Block)
if err != nil {
hr.logger.Warningf("[%s][%s] Last block attestation verification failed, blockNum [%d], err: %s", hr.chainID, hr.endpoint, blockNum, err)
return
}
} else { // a config block is a full block, so verify it as such, and update the verifier
err := hr.updatableBlockVerifier.VerifyBlock(t.Block)
if err != nil {
hr.logger.Warningf("[%s][%s] Last config block verification failed, blockNum [%d], err: %s", hr.chainID, hr.endpoint, blockNum, err)
return
}
if err := hr.updatableBlockVerifier.UpdateConfig(t.Block); err != nil {
hr.logger.Warningf("config block [%d] from orderer [%s] failed to update block verifier, error: %s", blockNum, hr.endpoint, err)
return
}
hr.logger.Infof("[%s][%s] Applied config block to header verifier, blockNum = [%d]", hr.chainID, hr.endpoint, blockNum)
}
hr.logger.Debugf("[%s][%s] Saving block header & metadata, blockNum = [%d]", hr.chainID, hr.endpoint, blockNum)
hr.updatableBlockVerifier.UpdateBlockHeader(t.Block)
hr.mutex.Lock()
hr.lastHeader = t.Block
hr.lastHeaderTime = time.Now()
hr.mutex.Unlock()
default:
hr.logger.Warningf("[%s][%s] Received unknown response type: %v", hr.chainID, hr.endpoint, t)
return
}
}
normalExit = true
}
func (hr *BFTHeaderReceiver) IsStopped() bool {
hr.mutex.Lock()
defer hr.mutex.Unlock()
return hr.stop
}
func (hr *BFTHeaderReceiver) IsStarted() bool {
hr.mutex.Lock()
defer hr.mutex.Unlock()
return hr.started
}
func (hr *BFTHeaderReceiver) setStarted() {
hr.mutex.Lock()
defer hr.mutex.Unlock()
hr.started = true
}
func (hr *BFTHeaderReceiver) GetErrorStopTime() time.Time {
hr.mutex.Lock()
defer hr.mutex.Unlock()
return hr.errorStopTime
}
// Stop the reception of headers and close the client connection
func (hr *BFTHeaderReceiver) Stop() error {
hr.mutex.Lock()
defer hr.mutex.Unlock()
if hr.stop {
hr.logger.Infof("[%s][%s] Already stopped", hr.chainID, hr.endpoint)
return nil
}
hr.logger.Infof("[%s][%s] Stopping", hr.chainID, hr.endpoint)
hr.stop = true
_ = hr.client.CloseSend()
// TODO close the underlying connection as well
close(hr.stopChan)
return nil
}
// LastBlockNum returns the last block number which was verified
func (hr *BFTHeaderReceiver) LastBlockNum() (uint64, time.Time, error) {
hr.mutex.Lock()
defer hr.mutex.Unlock()
if hr.lastHeader == nil {
return 0, time.Time{}, errors.New("not found")
}
return hr.lastHeader.Header.Number, hr.lastHeaderTime, nil
}
// LastBlock returns the last block which was verified
func (hr *BFTHeaderReceiver) LastBlock() (*common.Block, time.Time, error) {
hr.mutex.Lock()
defer hr.mutex.Unlock()
if hr.lastHeader == nil {
return nil, time.Time{}, errors.New("not found")
}
return hr.lastHeader, hr.lastHeaderTime, nil
}
```
|
Kawanaphila pachomai is a species of insect in the family Tettigoniidae. It is endemic to Australia.
References
Tettigoniidae
Orthoptera of Australia
Endangered fauna of Australia
Insects described in 1993
Taxonomy articles created by Polbot
|
```javascript
/**
* Duo Web SDK v2
*/
(function (root, factory) {
/*eslint-disable */
if (typeof define === 'function' && define.amd) {
// AMD. Register as an anonymous module.
define([], factory);
/*eslint-enable */
} else if (typeof module === 'object' && module.exports) {
// Node. Does not work with strict CommonJS, but
// only CommonJS-like environments that support module.exports,
// like Node.
module.exports = factory();
} else {
// Browser globals (root is window)
var Duo = factory();
// If the Javascript was loaded via a script tag, attempt to autoload
// the frame.
Duo._onReady(Duo.init);
// Attach Duo to the `window` object
root.Duo = Duo;
}
}(this, function() {
var DUO_MESSAGE_FORMAT = /^(?:AUTH|ENROLL)+\|[A-Za-z0-9\+\/=]+\|[A-Za-z0-9\+\/=]+$/;
var DUO_ERROR_FORMAT = /^ERR\|[\w\s\.\(\)]+$/;
var DUO_OPEN_WINDOW_FORMAT = /^DUO_OPEN_WINDOW\|/;
var VALID_OPEN_WINDOW_DOMAINS = [
'duo.com',
'duosecurity.com',
'duomobile.s3-us-west-1.amazonaws.com'
];
var iframeId = 'duo_iframe',
postAction = '',
postArgument = 'sig_response',
host,
sigRequest,
duoSig,
appSig,
iframe,
submitCallback;
function throwError(message, url) {
throw new Error(
'Duo Web SDK error: ' + message +
(url ? ('\n' + 'See ' + url + ' for more information') : '')
);
}
function hyphenize(str) {
return str.replace(/([a-z])([A-Z])/, '$1-$2').toLowerCase();
}
// cross-browser data attributes
function getDataAttribute(element, name) {
if ('dataset' in element) {
return element.dataset[name];
} else {
return element.getAttribute('data-' + hyphenize(name));
}
}
// cross-browser event binding/unbinding
function on(context, event, fallbackEvent, callback) {
if ('addEventListener' in window) {
context.addEventListener(event, callback, false);
} else {
context.attachEvent(fallbackEvent, callback);
}
}
function off(context, event, fallbackEvent, callback) {
if ('removeEventListener' in window) {
context.removeEventListener(event, callback, false);
} else {
context.detachEvent(fallbackEvent, callback);
}
}
function onReady(callback) {
on(document, 'DOMContentLoaded', 'onreadystatechange', callback);
}
function offReady(callback) {
off(document, 'DOMContentLoaded', 'onreadystatechange', callback);
}
function onMessage(callback) {
on(window, 'message', 'onmessage', callback);
}
function offMessage(callback) {
off(window, 'message', 'onmessage', callback);
}
/**
* Parse the sig_request parameter, throwing errors if the token contains
* a server error or if the token is invalid.
*
* @param {String} sig Request token
*/
function parseSigRequest(sig) {
if (!sig) {
// nothing to do
return;
}
// see if the token contains an error, throwing it if it does
if (sig.indexOf('ERR|') === 0) {
throwError(sig.split('|')[1]);
}
// validate the token
if (sig.indexOf(':') === -1 || sig.split(':').length !== 2) {
throwError(
'Duo was given a bad token. This might indicate a configuration ' +
'problem with one of Duo\'s client libraries.',
'path_to_url#first-steps'
);
}
var sigParts = sig.split(':');
// hang on to the token, and the parsed duo and app sigs
sigRequest = sig;
duoSig = sigParts[0];
appSig = sigParts[1];
return {
sigRequest: sig,
duoSig: sigParts[0],
appSig: sigParts[1]
};
}
/**
* This function is set up to run when the DOM is ready, if the iframe was
* not available during `init`.
*/
function onDOMReady() {
iframe = document.getElementById(iframeId);
if (!iframe) {
throw new Error(
'This page does not contain an iframe for Duo to use.' +
'Add an element like <iframe id="duo_iframe"></iframe> ' +
'to this page. ' +
'See path_to_url#3.-show-the-iframe ' +
'for more information.'
);
}
// we've got an iframe, away we go!
ready();
// always clean up after yourself
offReady(onDOMReady);
}
/**
* Validate that a MessageEvent came from the Duo service, and that it
* is a properly formatted payload.
*
* The Google Chrome sign-in page injects some JS into pages that also
* make use of postMessage, so we need to do additional validation above
* and beyond the origin.
*
* @param {MessageEvent} event Message received via postMessage
*/
function isDuoMessage(event) {
return Boolean(
event.origin === ('path_to_url + host) &&
typeof event.data === 'string' &&
(
event.data.match(DUO_MESSAGE_FORMAT) ||
event.data.match(DUO_ERROR_FORMAT) ||
event.data.match(DUO_OPEN_WINDOW_FORMAT)
)
);
}
/**
* Validate the request token and prepare for the iframe to become ready.
*
* All options below can be passed into an options hash to `Duo.init`, or
* specified on the iframe using `data-` attributes.
*
* Options specified using the options hash will take precedence over
* `data-` attributes.
*
* Example using options hash:
* ```javascript
* Duo.init({
* iframe: "some_other_id",
* host: "api-main.duo.test",
* sig_request: "...",
* post_action: "/auth",
* post_argument: "resp"
* });
* ```
*
* Example using `data-` attributes:
* ```
* <iframe id="duo_iframe"
* data-host="api-main.duo.test"
* data-sig-request="..."
* data-post-action="/auth"
* data-post-argument="resp"
* >
* </iframe>
* ```
*
* @param {Object} options
* @param {String} options.iframe The iframe, or id of an iframe to set up
* @param {String} options.host Hostname
* @param {String} options.sig_request Request token
* @param {String} [options.post_action=''] URL to POST back to after successful auth
* @param {String} [options.post_argument='sig_response'] Parameter name to use for response token
* @param {Function} [options.submit_callback] If provided, duo will not submit the form instead execute
* the callback function with reference to the "duo_form" form object
* submit_callback can be used to prevent the webpage from reloading.
*/
function init(options) {
if (options) {
if (options.host) {
host = options.host;
}
if (options.sig_request) {
parseSigRequest(options.sig_request);
}
if (options.post_action) {
postAction = options.post_action;
}
if (options.post_argument) {
postArgument = options.post_argument;
}
if (options.iframe) {
if (options.iframe.tagName) {
iframe = options.iframe;
} else if (typeof options.iframe === 'string') {
iframeId = options.iframe;
}
}
if (typeof options.submit_callback === 'function') {
submitCallback = options.submit_callback;
}
}
// if we were given an iframe, no need to wait for the rest of the DOM
if (iframe) {
ready();
} else {
// try to find the iframe in the DOM
iframe = document.getElementById(iframeId);
// iframe is in the DOM, away we go!
if (iframe) {
ready();
} else {
// wait until the DOM is ready, then try again
onReady(onDOMReady);
}
}
// always clean up after yourself!
offReady(init);
}
/**
* This function is called when a message was received from another domain
* using the `postMessage` API. Check that the event came from the Duo
* service domain, and that the message is a properly formatted payload,
* then perform the post back to the primary service.
*
* @param event Event object (contains origin and data)
*/
function onReceivedMessage(event) {
if (isDuoMessage(event)) {
if (event.data.match(DUO_OPEN_WINDOW_FORMAT)) {
var url = event.data.substring("DUO_OPEN_WINDOW|".length);
if (isValidUrlToOpen(url)) {
// Open the URL that comes after the DUO_WINDOW_OPEN token.
window.open(url, "_self");
}
}
else {
// the event came from duo, do the post back
doPostBack(event.data);
// always clean up after yourself!
offMessage(onReceivedMessage);
}
}
}
/**
* Validate that this passed in URL is one that we will actually allow to
* be opened.
* @param url String URL that the message poster wants to open
* @returns {boolean} true if we allow this url to be opened in the window
*/
function isValidUrlToOpen(url) {
if (!url) {
return false;
}
var parser = document.createElement('a');
parser.href = url;
if (parser.protocol === "duotrustedendpoints:") {
return true;
} else if (parser.protocol !== "https:") {
return false;
}
for (var i = 0; i < VALID_OPEN_WINDOW_DOMAINS.length; i++) {
if (parser.hostname.endsWith("." + VALID_OPEN_WINDOW_DOMAINS[i]) ||
parser.hostname === VALID_OPEN_WINDOW_DOMAINS[i]) {
return true;
}
}
return false;
}
/**
* Point the iframe at Duo, then wait for it to postMessage back to us.
*/
function ready() {
if (!host) {
host = getDataAttribute(iframe, 'host');
if (!host) {
throwError(
'No API hostname is given for Duo to use. Be sure to pass ' +
'a `host` parameter to Duo.init, or through the `data-host` ' +
'attribute on the iframe element.',
'path_to_url#3.-show-the-iframe'
);
}
}
if (!duoSig || !appSig) {
parseSigRequest(getDataAttribute(iframe, 'sigRequest'));
if (!duoSig || !appSig) {
throwError(
'No valid signed request is given. Be sure to give the ' +
'`sig_request` parameter to Duo.init, or use the ' +
'`data-sig-request` attribute on the iframe element.',
'path_to_url#3.-show-the-iframe'
);
}
}
// if postAction/Argument are defaults, see if they are specified
// as data attributes on the iframe
if (postAction === '') {
postAction = getDataAttribute(iframe, 'postAction') || postAction;
}
if (postArgument === 'sig_response') {
postArgument = getDataAttribute(iframe, 'postArgument') || postArgument;
}
// point the iframe at Duo
iframe.src = [
'path_to_url host, '/frame/web/v1/auth?tx=', duoSig,
'&parent=', encodeURIComponent(document.location.href),
'&v=2.6'
].join('');
// listen for the 'message' event
onMessage(onReceivedMessage);
}
/**
* We received a postMessage from Duo. POST back to the primary service
* with the response token, and any additional user-supplied parameters
* given in form#duo_form.
*/
function doPostBack(response) {
// create a hidden input to contain the response token
var input = document.createElement('input');
input.type = 'hidden';
input.name = postArgument;
input.value = response + ':' + appSig;
// user may supply their own form with additional inputs
var form = document.getElementById('duo_form');
// if the form doesn't exist, create one
if (!form) {
form = document.createElement('form');
// insert the new form after the iframe
iframe.parentElement.insertBefore(form, iframe.nextSibling);
}
// make sure we are actually posting to the right place
form.method = 'POST';
form.action = postAction;
// add the response token input to the form
form.appendChild(input);
// away we go!
if (typeof submitCallback === "function") {
submitCallback.call(null, form);
} else {
form.submit();
}
}
return {
init: init,
_onReady: onReady,
_parseSigRequest: parseSigRequest,
_isDuoMessage: isDuoMessage,
_doPostBack: doPostBack
};
}));
```
|
```java
/*
*
*
* path_to_url
*
* Unless required by applicable law or agreed to in writing, software
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*/
package io.camunda.zeebe.model.bpmn.impl.instance;
import static io.camunda.zeebe.model.bpmn.impl.BpmnModelConstants.BPMN20_NS;
import static io.camunda.zeebe.model.bpmn.impl.BpmnModelConstants.BPMN_ELEMENT_LOOP_CARDINALITY;
import io.camunda.zeebe.model.bpmn.instance.Expression;
import io.camunda.zeebe.model.bpmn.instance.LoopCardinality;
import org.camunda.bpm.model.xml.ModelBuilder;
import org.camunda.bpm.model.xml.impl.instance.ModelTypeInstanceContext;
import org.camunda.bpm.model.xml.type.ModelElementTypeBuilder;
import org.camunda.bpm.model.xml.type.ModelElementTypeBuilder.ModelTypeInstanceProvider;
/**
* The loopCardinality element from the tMultiInstanceLoopCharacteristics complex type
*
* @author Filip Hrisafov
*/
public class LoopCardinalityImpl extends ExpressionImpl implements LoopCardinality {
public LoopCardinalityImpl(final ModelTypeInstanceContext instanceContext) {
super(instanceContext);
}
public static void registerType(final ModelBuilder modelBuilder) {
final ModelElementTypeBuilder typeBuilder =
modelBuilder
.defineType(LoopCardinality.class, BPMN_ELEMENT_LOOP_CARDINALITY)
.namespaceUri(BPMN20_NS)
.extendsType(Expression.class)
.instanceProvider(
new ModelTypeInstanceProvider<LoopCardinality>() {
@Override
public LoopCardinality newInstance(
final ModelTypeInstanceContext instanceContext) {
return new LoopCardinalityImpl(instanceContext);
}
});
typeBuilder.build();
}
}
```
|
```java
/*
*
*
* path_to_url
*
* Unless required by applicable law or agreed to in writing, software
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*/
package io.ballerina.compiler.api.impl.symbols;
import io.ballerina.compiler.api.SymbolTransformer;
import io.ballerina.compiler.api.SymbolVisitor;
import io.ballerina.compiler.api.symbols.FloatTypeSymbol;
import io.ballerina.compiler.api.symbols.TypeDescKind;
import org.wso2.ballerinalang.compiler.semantics.model.types.BType;
import org.wso2.ballerinalang.compiler.util.CompilerContext;
/**
* Represents the float type descriptor.
*
* @since 2.0.0
*/
public class BallerinaFloatTypeSymbol extends AbstractTypeSymbol implements FloatTypeSymbol {
public BallerinaFloatTypeSymbol(CompilerContext context, BType floatType) {
super(context, TypeDescKind.FLOAT, floatType);
}
@Override
public String signature() {
return "float";
}
@Override
public void accept(SymbolVisitor visitor) {
visitor.visit(this);
}
@Override
public <T> T apply(SymbolTransformer<T> transformer) {
return transformer.transform(this);
}
}
```
|
Březina is a municipality and village in Brno-Country District in the South Moravian Region of the Czech Republic. It has about 1,100 inhabitants.
Březina lies approximately north-east of Brno and south-east of Prague.
History
The first written mention of Březina is from 1365. The village of Proseč was first mentioned in 1395. In 1950, both villages were merged into one municipality. Since 1 January 2007, Březina has been no longer part of Blansko District and became part of the Brno-Country District.
Demographics
Twin towns – sister cities
Březina is twinned with:
Valaská Dubová, Slovakia
References
Villages in Brno-Country District
|
Bristol City Council is the local authority of Bristol, England. The council is a unitary authority, and is unusual in the United Kingdom in that its executive function is controlled by its directly elected mayor. Bristol has 34 wards, electing a total of 70 councillors.
History
The council was formed by the Local Government Act 1972. It was first elected in 1973, a year before formally coming into its powers and prior to the creation of the non-metropolitan district of Bristol on 1 April 1974.
Under the Local Government Act 1972 Bristol as a non-metropolitan district council would share power with the Avon County Council. This arrangement lasted until 1996 when Avon County Council was abolished and Bristol City Council gained responsibility for services that had been provided by the county council.
Political composition
Mayor
The mayor of Bristol following the 2021 mayoral election is Marvin Rees for the Labour Party. Originally intended to serve for four years from 2016, his first term was extended by a year due to the COVID-19 pandemic. He was re-elected for a shortened three-year term in 2021.
Rees had previously ran in the first Bristol mayoral election, coming second place to the independent George Ferguson.
On 7 December 2021, the majority of opposition councillors backed a legally binding motion to hold a referendum on the future of the role of the Elected Mayor of Bristol. The referendum on in May 2022 offered Bristolians the choice of keeping an elected mayor or reverting to a committee system of governance. The result was to abolish the role of mayor from May 2024.
Councillors
Following the 2021 Bristol City Council election, no party held a majority in the chamber, with both the Green Party and Labour holding the same number of seats. The council had previously been controlled by the Labour Party since 2016, and the council continues to be led by the directly-elected executive Mayor.
The Liberal Democrats gained eight seats in the election. However, on 13 December 2021, former Lord Mayor Chris Davies and former Lib Dem Bristol group leader Gary Hopkins defected from the party to form the Knowle Community Party.
On 24 December 2021, the Labour councillor for Southmead, Helen Godwin, announced she would be resigning, triggering a by-election for 17 February 2022, at which Kye Dudd (former councillor for Central until May 2021) of the Labour Party was elected to replace her.
The Green Party became the largest party in 2023 following the Hotwells and Harbourside by-election, gaining a seat from the Liberal Democrats.
Cabinet
The cabinet is led by Mayor Marvin Rees and currently consists of nine members (including Rees). All cabinet members are currently part of the Labour Party despite them being the second biggest party.
Bristol City Youth Council
The Bristol City Youth Council (BCYC) are an elected group of young people aged 11 to 18. Members are voted for in the Bristol Big Youth Vote, which takes place in schools, with students voting. The constituencies for Youth Council are divided into Bristol North, Bristol East Central, and Bristol South, with each area having eight members. This is in addition to several co-optees from special representation groups such as Young Carers, Unity Youth, and the Children in Care Council.
The purpose of the Youth Council is express young people's views on the decisions that are important to them and that their opinions are voiced and heard. They also run internal and external campaigns
The Youth Council also internally elects two members of youth parliament (MYP), and two youth mayors. The youth mayors act as advisors to the mayor, Marvin Rees, and attend meetings and accompany him to events. As of February 2023, the Youth Mayors are Mya Parker and Felix Massey.
See also
Bristol City Council elections
History of Bristol City Council
Politics of Bristol
References
External links
Unitary authority councils of England
Local education authorities in England
Local authorities in Bristol
Billing authorities in England
Local government in Bristol
Mayor and cabinet executives
1974 establishments in England
Government agencies established in 1974
|
```javascript
Async and defer scripts
Form a `URL` from its parts
Window.sessionStorage
Network Information API
MediaDevices.getUserMedia()
```
|
Richard Agustín Rodríguez (born March 4, 1990) is a Dominican professional baseball pitcher in the Miami Marlins organization. He previously played in Major League Baseball (MLB) for the Baltimore Orioles, Pittsburgh Pirates, and Atlanta Braves.
Career
Houston Astros
On May 26, 2010, Rodríguez began his professional career by signing with the Houston Astros organization, and was assigned to the DSL Astros. He spent 2011 in the DSL and with the GCL Astros. He spent 2012 with the Greeneville Astros, GCL Astros, and Lexington Legends. In 2013, he played for Greeneville, the Quad Cities River Bandits, and Tri-City ValleyCats. In 2014, he spent time with the Bandits, Lancaster JetHawks, Oklahoma City RedHawks, and Corpus Christi Hooks. He began the 2015 season with the Fresno Grizzlies.
Baltimore Orioles
On June 25, 2015, Rodríguez was acquired by the Orioles from the Houston Astros for a player to be named later or cash. He spent the rest of the 2015 season with the Bowie Baysox and the Norfolk Tides. Rodriguez spent the entire 2016 season with Norfolk and was invited to Spring Training for the 2017 season. He did not make the club and was reassigned to the Tides.
Rodríguez was called up to the majors for the first time on September 1, 2017. Rodríguez was designated for assignment by the Orioles on September 17 following the promotion of Tanner Scott and outrighted the same day. In 5 relief appearances, he has posted a 14.29 ERA. He elected free agency following the season on November 6.
Pittsburgh Pirates
On December 8, 2017, Rodríguez signed a minor league contract with the Pittsburgh Pirates. He began the 2018 season with the Indianapolis Indians of the Class AAA International League, and was promoted to the major leagues on April 13. In his first season as a Pirate, he went 4–3 with a 2.47 ERA in 63 games. He struck out 88 batters in innings.
In 2019, he went 4–5 with a 3.72 ERA, striking out 63 batters in innings. He made 72 appearances, the most on the team among pitchers. In 2020 for Pittsburgh, Rodríguez pitched to a 3-2 record with a 2.70 ERA, 34 strikeouts, and 4 saves in 23.1 innings of work.
Atlanta Braves
On July 30, 2021, Rodriguez was traded to the Atlanta Braves in exchange for Bryse Wilson and Ricky DeVito. Between the two teams, he was 5-4 with 14 saves and a 2.94 ERA, as in 64 relief appearances he pitched 64.1 innings with an 0.933 WHIP. The Braves finished with an 88-73 record, clinching the NL East, and eventually won the 2021 World Series, giving the Braves their first title since 1995.
On November 30, Rodríguez was non-tendered by the Braves, making him a free agent.
On April 4, 2022, Rodríguez was suspended by MLB for 80 games after violation of their Joint Drug Prevention and Treatment Program, testing positive for Boldenone.
New York Yankees
On June 21, 2022, Rodríguez signed a minor league deal with the New York Yankees. Rodríguez made 17 appearances for the Triple-A Scranton/Wilkes-Barre RailRiders, pitching to a 3-1 record and 3.86 ERA with 21 strikeouts in 22.1 innings of work. He elected free agency following the season on November 10, 2022.
Miami Marlins
On February 28, 2023, Rodríguez signed a minor league contract with the Miami Marlins organization that included an invitation to Spring Training.
References
External links
1990 births
Living people
Águilas Cibaeñas players
Atlanta Braves players
Baltimore Orioles players
Bowie Baysox players
Corpus Christi Hooks players
Dominican Republic expatriate baseball players in the United States
Dominican Republic sportspeople in doping cases
Dominican Summer League Astros players
Florida Complex League Yankees players
Fresno Grizzlies players
Greeneville Astros players
Gulf Coast Astros players
Jacksonville Jumbo Shrimp players
Indianapolis Indians players
Lancaster JetHawks players
Lexington Legends players
Major League Baseball players from the Dominican Republic
Major League Baseball pitchers
Norfolk Tides players
Oklahoma City RedHawks players
Pittsburgh Pirates players
Quad Cities River Bandits players
Tri-City ValleyCats players
Baseball players from Santiago de los Caballeros
|
```shell
make
if [ ! -e text8 ]; then
wget path_to_url -O text8.gz
gzip -d text8.gz -f
fi
time ./word2vec -train text8 -output classes.txt -cbow 1 -size 200 -window 8 -negative 25 -hs 0 -sample 1e-4 -threads 20 -iter 15 -classes 500
sort classes.txt -k 2 -n > classes.sorted.txt
echo The word classes were saved to file classes.sorted.txt
```
|
```xml
import { TestBed } from '@angular/core/testing';
import { AngularFireModule } from '@angular/fire/compat';
import { AngularFirePerformance, AngularFirePerformanceModule } from '@angular/fire/compat/performance';
import { COMMON_CONFIG } from '../../../src/test-config';
describe('AngularFirePerformance', () => {
let afp: AngularFirePerformance;
beforeEach(() => {
TestBed.configureTestingModule({
imports: [
// NOTE: You must use the [DEFAULT] app instance
// for these tests to work.
AngularFireModule.initializeApp(COMMON_CONFIG),
AngularFirePerformanceModule
]
});
afp = TestBed.inject(AngularFirePerformance);
});
it('should exist', () => {
expect(afp instanceof AngularFirePerformance).toBe(true);
});
it('should have the Performance instance', () => {
expect(afp.dataCollectionEnabled).toBeDefined();
});
});
```
|
```c++
// Use, modification, and distribution is subject to the Boost Software
// path_to_url
// See library home page at path_to_url
//
// Contact the author at: fernando_cacciola@hotmail.com
//
#ifndef your_sha256_hashHPP
#define your_sha256_hashHPP
namespace boost { namespace numeric
{
enum udt_builtin_mixture_enum
{
builtin_to_builtin
,builtin_to_udt
,udt_to_builtin
,udt_to_udt
} ;
} } // namespace boost::numeric
#endif
```
|
```javascript
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// Flags: --expose-wasm
load("test/mjsunit/wasm/wasm-module-builder.js");
(function() {
print("F32: sNaN - 0 = qNaN");
var builder = new WasmModuleBuilder();
builder.addFunction("F32Sub0", kSig_i_i).addBody(
[ kExprGetLocal, 0, kExprF32ReinterpretI32, kExprF32Const, 0x00, 0x00,
0x00, 0x00, // 0.0
kExprF32Sub, kExprI32ReinterpretF32, ]).exportFunc();
var module = builder.instantiate();
// F32Sub0(signalling_NaN)
assertEquals(0x7fe00000, module.exports.F32Sub0(0x7fa00000));
})();
(function() {
print("F32: -0 sNaN = qNaN");
var builder = new WasmModuleBuilder();
builder.addFunction("F32Sub0", kSig_i_i).addBody(
[ kExprF32Const, 0x00, 0x00, 0x00, 0x80, // 0.0
kExprGetLocal, 0, kExprF32ReinterpretI32, kExprF32Sub,
kExprI32ReinterpretF32, ]).exportFunc();
var module = builder.instantiate();
// F32Sub0(signalling_NaN)
assertEquals(0x7fe00000, module.exports.F32Sub0(0x7fa00000));
})();
(function() {
print("F32: sNaN - X = qNaN");
var builder = new WasmModuleBuilder();
builder.addFunction("F32NaNSubX", kSig_i_i).addBody(
[ kExprF32Const, 0x00, 0x00, 0xa0, 0x7f, kExprF32Const, 0x12, 0x34, 0x56,
0x78, kExprF32Sub, kExprI32ReinterpretF32, ]).exportFunc();
var module = builder.instantiate();
assertEquals(0x7fe00000, module.exports.F32NaNSubX());
})();
(function() {
print("F32: X - sNaN = qNaN");
var builder = new WasmModuleBuilder();
builder.addFunction("F32XSubNaN", kSig_i_i).addBody(
[ kExprF32Const, 0x12, 0x34, 0x56, 0x78, kExprF32Const, 0x00, 0x00, 0xa0,
0x7f, kExprF32Sub, kExprI32ReinterpretF32, ]).exportFunc();
var module = builder.instantiate();
assertEquals(0x7fe00000, module.exports.F32XSubNaN());
})();
(function() {
print("F64: X + sNaN = qNaN");
var builder = new WasmModuleBuilder();
builder.addFunction("F32XAddNaN", kSig_i_i).addBody(
[ kExprF64Const, 0xde, 0xbc, 0x0a, 0x89, 0x67, 0x45, 0x23, 0x01,
kExprF64Const, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xf2, 0x7f,
kExprF64Add, kExprI64ReinterpretF64, kExprI64Const, 32, kExprI64ShrU,
kExprI32ConvertI64, ]).exportFunc();
var module = builder.instantiate();
assertEquals(0x7ffa0000, module.exports.F32XAddNaN());
})();
(function() {
print("F64: sNaN - 0 = qNaN");
var builder = new WasmModuleBuilder();
builder.addFunction("F64Sub0", kSig_i_i).addBody(
[ kExprI64Const, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0xf9, 0xff,
0x00, kExprF64ReinterpretI64, kExprF64Const, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, // 0.0
kExprF64Sub, kExprI64ReinterpretF64, kExprI64Const, 32, kExprI64ShrU,
kExprI32ConvertI64, ]).exportFunc();
var module = builder.instantiate();
assertEquals(0x7ffa0000, module.exports.F64Sub0());
})();
(function() {
print("F64: -0 - sNaN = qNaN");
var builder = new WasmModuleBuilder();
builder.addFunction("F64Sub0", kSig_i_i).addBody(
[ kExprF64Const, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x80, // 0.0
kExprI64Const, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0xf9, 0xff,
0x00, kExprF64ReinterpretI64, kExprF64Sub, kExprI64ReinterpretF64,
kExprI64Const, 32, kExprI64ShrU, kExprI32ConvertI64, ]).exportFunc();
var module = builder.instantiate();
assertEquals(0x7ffa0000, module.exports.F64Sub0());
})();
(function() {
print("F64: sNaN - X = qNaN");
var builder = new WasmModuleBuilder();
builder.addFunction("F64NaNSubX", kSig_i_i).addBody(
[ kExprF64Const, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xf2, 0x7f,
kExprF64Const, 0xde, 0xbc, 0x0a, 0x89, 0x67, 0x45, 0x23, 0x01,
kExprF64Sub, kExprI64ReinterpretF64, kExprI64Const, 32, kExprI64ShrU,
kExprI32ConvertI64, ]).exportFunc();
var module = builder.instantiate();
assertEquals(0x7ffa0000, module.exports.F64NaNSubX());
})();
(function() {
print("F64: X - sNaN = qNaN");
var builder = new WasmModuleBuilder();
builder.addFunction("F64XSubNaN", kSig_i_i).addBody(
[ kExprF64Const, 0xde, 0xbc, 0x0a, 0x89, 0x67, 0x45, 0x23, 0x01,
kExprF64Const, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xf2, 0x7f,
kExprF64Sub, kExprI64ReinterpretF64, kExprI64Const, 32, kExprI64ShrU,
kExprI32ConvertI64, ]).exportFunc();
var module = builder.instantiate();
assertEquals(0x7ffa0000, module.exports.F64XSubNaN());
})();
(function() {
print("F64: sNaN * 1 = qNaN");
var builder = new WasmModuleBuilder();
builder.addFunction("F64Mul1", kSig_i_i).addBody(
[ kExprI64Const, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0xf9, 0xff,
0x00, kExprF64ReinterpretI64, kExprF64Const, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0xf0, 0x3f, kExprF64Mul, kExprI64ReinterpretF64,
kExprI64Const, 32, kExprI64ShrU, kExprI32ConvertI64, ]).exportFunc();
var module = builder.instantiate();
assertEquals(0x7ffa0000, module.exports.F64Mul1());
})();
(function() {
print("F64: X * sNaN = qNaN");
var builder = new WasmModuleBuilder();
builder.addFunction("F64XMulNaN", kSig_i_i).addBody(
[ kExprF64Const, 0xde, 0xbc, 0x0a, 0x89, 0x67, 0x45, 0x23, 0x01,
kExprF64Const, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xf2, 0x7f,
kExprF64Mul, kExprI64ReinterpretF64, kExprI64Const, 32, kExprI64ShrU,
kExprI32ConvertI64, ]).exportFunc();
var module = builder.instantiate();
assertEquals(0x7ffa0000, module.exports.F64XMulNaN());
})();
(function() {
print("F64: sNaN / 1 = qNaN");
var builder = new WasmModuleBuilder();
builder.addFunction("F64Div1", kSig_i_i).addBody(
[ kExprI64Const, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0xf9, 0xff,
0x00, kExprF64ReinterpretI64, kExprF64Const, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0xf0, 0x3f, kExprF64Div, kExprI64ReinterpretF64,
kExprI64Const, 32, kExprI64ShrU, kExprI32ConvertI64, ]).exportFunc();
var module = builder.instantiate();
assertEquals(0x7ffa0000, module.exports.F64Div1());
})();
(function() {
print("F64: sNaN / -1 = qNaN");
var builder = new WasmModuleBuilder();
builder.addFunction("F64Div1", kSig_i_i).addBody(
[ kExprI64Const, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0xf9, 0xff,
0x00, kExprF64ReinterpretI64, kExprF64Const, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0xf0, 0xbf, kExprF64Div, kExprI64ReinterpretF64,
kExprI64Const, 32, kExprI64ShrU, kExprI32ConvertI64, ]).exportFunc();
var module = builder.instantiate();
assertEquals(0x7ffa0000, module.exports.F64Div1());
})();
(function() {
print("F64: sNaN / -1 = qNaN");
var builder = new WasmModuleBuilder();
builder.addFunction("F64Div1", kSig_i_i)
.addBody([
kExprI64Const, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0xf9, 0xff, 0x00,
kExprF64ReinterpretI64,
kExprF64Const, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xf0, 0xbf,
kExprF64Div,
kExprI64ReinterpretF64,
kExprI64Const, 32,
kExprI64ShrU,
kExprI32ConvertI64,
])
.exportFunc();
var module = builder.instantiate();
assertEquals(0x7ffa0000, module.exports.F64Div1());
})();
(function() {
print("F64: X / sNaN = qNaN");
var builder = new WasmModuleBuilder();
builder.addFunction("F64XDivNaN", kSig_i_i).addBody(
[ kExprF64Const, 0xde, 0xbc, 0x0a, 0x89, 0x67, 0x45, 0x23, 0x01,
kExprF64Const, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xf2, 0x7f,
kExprF64Div, kExprI64ReinterpretF64, kExprI64Const, 32, kExprI64ShrU,
kExprI32ConvertI64, ]).exportFunc();
var module = builder.instantiate();
assertEquals(0x7ffa0000, module.exports.F64XDivNaN());
})();
(function() {
print("F64: sNaN / X = qNaN");
var builder = new WasmModuleBuilder();
builder.addFunction("F64NaNDivX", kSig_i_i).addBody(
[ kExprF64Const, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xf2, 0x7f,
kExprF64Const, 0xde, 0xbc, 0x0a, 0x89, 0x67, 0x45, 0x23, 0x01,
kExprF64Div, kExprI64ReinterpretF64, kExprI64Const, 32, kExprI64ShrU,
kExprI32ConvertI64, ]).exportFunc();
var module = builder.instantiate();
assertEquals(0x7ffa0000, module.exports.F64NaNDivX());
})();
(function() {
print("F32ConvertF64(sNaN) = qNaN");
var builder = new WasmModuleBuilder();
builder.addFunction("F32ConvertF64X", kSig_i_i).addBody(
[ kExprF64Const, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xf2, 0x7f,
kExprF32ConvertF64, kExprI32ReinterpretF32, ]).exportFunc();
var module = builder.instantiate();
assertEquals(0x7fd00000, module.exports.F32ConvertF64X());
})();
(function() {
print("F64ConvertF32(sNaN) = qNaN");
var builder = new WasmModuleBuilder();
builder.addFunction("F64ConvertF32X", kSig_i_i).addBody(
[ kExprF32Const, 0x00, 0x00, 0xa0, 0x7f, kExprF64ConvertF32,
kExprI64ReinterpretF64, kExprI64Const, 32, kExprI64ShrU,
kExprI32ConvertI64, ]).exportFunc();
var module = builder.instantiate();
assertEquals(0x7ffc0000, module.exports.F64ConvertF32X());
})();
(function() {
print("F64ConvertF32(F32ConvertF64(sNaN)) = qNaN");
var builder = new WasmModuleBuilder();
builder.addFunction("F64toF32toF64", kSig_i_i).addBody(
[ kExprI64Const, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0xf9, 0xff,
0x00, kExprF64ReinterpretI64, kExprF32ConvertF64, kExprF64ConvertF32,
kExprI64ReinterpretF64, kExprI64Const, 32, kExprI64ShrU,
kExprI32ConvertI64, ]).exportFunc();
var module = builder.instantiate();
assertEquals(0x7ffa0000, module.exports.F64toF32toF64());
})();
```
|
```javascript
!function(a){"function"==typeof define&&define.amd?define(["jquery","moment"],a):"object"==typeof exports?module.exports=a(require("jquery"),require("moment")):a(jQuery,moment)}(function(a,b){!function(){"use strict";var a=(b.defineLocale||b.lang).call(b,"en-nz",{months:your_sha256_hashber_November_December".split("_"),monthsShort:"Jan_Feb_Mar_Apr_May_Jun_Jul_Aug_Sep_Oct_Nov_Dec".split("_"),weekdays:"Sunday_Monday_Tuesday_Wednesday_Thursday_Friday_Saturday".split("_"),weekdaysShort:"Sun_Mon_Tue_Wed_Thu_Fri_Sat".split("_"),weekdaysMin:"Su_Mo_Tu_We_Th_Fr_Sa".split("_"),longDateFormat:{LT:"h:mm A",LTS:"h:mm:ss A",L:"DD/MM/YYYY",LL:"D MMMM YYYY",LLL:"D MMMM YYYY h:mm A",LLLL:"dddd, D MMMM YYYY h:mm A"},calendar:{sameDay:"[Today at] LT",nextDay:"[Tomorrow at] LT",nextWeek:"dddd [at] LT",lastDay:"[Yesterday at] LT",lastWeek:"[Last] dddd [at] LT",sameElse:"L"},relativeTime:{future:"in %s",past:"%s ago",s:"a few seconds",m:"a minute",mm:"%d minutes",h:"an hour",hh:"%d hours",d:"a day",dd:"%d days",M:"a month",MM:"%d months",y:"a year",yy:"%d years"},ordinalParse:/\d{1,2}(st|nd|rd|th)/,ordinal:function(a){var b=a%10,c=1===~~(a%100/10)?"th":1===b?"st":2===b?"nd":3===b?"rd":"th";return a+c},week:{dow:1,doy:4}});return a}(),a.fullCalendar.datepickerLang("en-nz","en-NZ",{closeText:"Done",prevText:"Prev",nextText:"Next",currentText:"Today",monthNames:["January","February","March","April","May","June","July","August","September","October","November","December"],monthNamesShort:["Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"],dayNames:["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],dayNamesShort:["Sun","Mon","Tue","Wed","Thu","Fri","Sat"],dayNamesMin:["Su","Mo","Tu","We","Th","Fr","Sa"],weekHeader:"Wk",dateFormat:"dd/mm/yy",firstDay:1,isRTL:!1,showMonthAfterYear:!1,yearSuffix:""}),a.fullCalendar.lang("en-nz")});
```
|
Aboker is one of the woredas in the Harari Region of Ethiopia.
References
Districts of Harari Region
|
The Pulitzer Prize for Feature Writing is one of the fourteen American Pulitzer Prizes that are annually awarded for Journalism. It has been awarded since 1979 for a distinguished example of feature writing giving prime consideration to high literary quality and originality.
Finalists have been announced from 1980, ordinarily two others beside the winner.
Winners and citations
In its first 35 years to 2013, the Feature Writing Pulitzer was awarded 34 times; none was given in 2004 and 2014, and it was never split. Gene Weingarten alone won it twice, in 2008 and 2010.
1979: Jon D. Franklin, Baltimore Evening Sun, for 'Mrs. Kelly's Monster', "an account of brain surgery."
1980: Madeleine Blais, Miami Herald, "for 'Zepp's Last Stand.'"
1981: Teresa Carpenter, Village Voice, for Death of a Playmate, "her account of the death of actress-model Dorothy Stratten." (The prize in this category was originally awarded to Janet Cooke of The Washington Post, but was revoked after it was revealed that her winning story about an 8-year-old heroin addict was fabricated.)
1982: Saul Pett, Associated Press, "for an article profiling the federal bureaucracy."
1983: Nan C. Robertson, The New York Times, for Toxic Shock, "her memorable and medically detailed account of her struggle with toxic shock syndrome."
1984: Peter Mark Rinearson, The Seattle Times, "for 'Making It Fly,' his 29,000-word account of the development, manufacture, and marketing of the new Boeing 757" jetliner.
1985: Alice Steinbach, The Baltimore Sun, "for her account of a blind boy's world, 'A Boy of Unusual Vision.'"
1986: John Camp, St. Paul Pioneer Press and Dispatch, for Life on the Land, "his five-part series examining the life of an American farm family faced with the worst U.S. agricultural crisis since the Depression."
1987: Steve Twomey, The Philadelphia Inquirer, "for his illuminating profile of life aboard an aircraft carrier."
1988: Jacqui Banaszynski, St. Paul Pioneer Press and Dispatch, "for her moving series about the life and death of an AIDS victim in a rural farm community."
1989: David Zucchino, The Philadelphia Inquirer, "for his richly compelling series, 'Being Black in South Africa.'"
1990: Dave Curtin, Colorado Springs Gazette Telegraph, "for a gripping account of a family's struggle to recover after its members were severely burned in an explosion that devastated their home."
1991: Sheryl James, St. Petersburg Times, "for a compelling series about a mother who abandoned her newborn child and how it affected her life and those of others."
1992: Howell Raines, The New York Times, "for 'Grady's Gift,' an account of the author's childhood friendship with his family's black housekeeper and the lasting lessons of their relationship."
1993: George Lardner Jr., The Washington Post, "for his unflinching examination of his daughter's murder by a violent man who had slipped through the criminal justice system."
1994: Isabel Wilkerson, The New York Times, "for her profile of a fourth-grader from Chicago's South Side and for two stories reporting on the Midwestern flood of 1993."
1995: Ron Suskind, The Wall Street Journal, "for his stories about inner-city honor students in Washington, D.C., and their determination to survive and prosper." These articles would later become his first book "A Hope in the Unseen"
1996: Rick Bragg, The New York Times, "for his elegantly written stories about contemporary America."
1997: Lisa Pollak, The Baltimore Sun, "for her compelling portrait of a baseball umpire who endured the death of a son while knowing that another son suffers from the same deadly genetic disease."
1998: Thomas French, St. Petersburg Times, "for his detailed and compassionate narrative portrait of a mother and two daughters slain on a Florida vacation, and the three-year investigation into their murders."
1999: Angelo B. Henderson, The Wall Street Journal, "for his portrait of a druggist who is driven to violence by his encounters with armed robbery, illustrating the lasting effects of crime."
2000: J.R. Moehringer, Los Angeles Times, for Crossing Over, "his portrait of Gee's Bend, an isolated river community in Alabama where many descendants of slaves live, and how a proposed ferry to the mainland might change it."
2001: Tom Hallman, Jr., The Oregonian (Portland, Oregon), "for his poignant profile of a disfigured 14-year-old boy who elects to have life-threatening surgery in an effort to improve his appearance."
2002: Barry Siegel, Los Angeles Times, for A Father's Pain, a Judge's Duty, and a Justice Beyond Their Reach, "his humane and haunting portrait of a man tried for negligence in the death of his son, and the judge who heard the case."
2003: Sonia Nazario, Los Angeles Times, "for 'Enrique's Journey,' her touching, exhaustively reported story of a Honduran boy's perilous search for his mother who had migrated to the United States."
2004: not awarded
2005: Julia Keller of Chicago Tribune, "for her gripping, meticulously reconstructed account of a deadly 10-second tornado that ripped through Utica, Ill."
2006: Jim Sheeler of Rocky Mountain News, "for his poignant story on a Marine major who helps the families of comrades killed in Iraq cope with their loss and honor their sacrifice."
2007: Andrea Elliott of The New York Times, for 'Muslims in America Series,' "her intimate, richly textured portrait of an immigrant imam striving to find his way and serve his faithful in America."
2008: Gene Weingarten of The Washington Post, for 'Pearls Before Breakfast,' "his chronicling of a world-class violinist who, as an experiment, played beautiful music in a subway station filled with unheeding commuters."
2009: Lane DeGregory of St. Petersburg Times, for 'The Girl in the Window,' "her moving, richly detailed story of a neglected little girl, found in a roach-infested room, unable to talk or feed herself, who was adopted by a new family committed to her nurturing."
2010: Gene Weingarten of The Washington Post, for 'Fatal Distraction: Forgetting a Child in the Backseat of a Car Is a Horrifying Mistake. Is It a Crime?,' "his haunting story about parents, from varying walks of life, who accidentally kill their children by forgetting them in cars."
2011: Amy Ellis Nutt of the Newark Star-Ledger, for 'The Wreck of the Lady Mary,' "her deeply probing story of the mysterious sinking of a commercial fishing boat in the Atlantic Ocean that drowned six men."
2012: Eli Sanders of The Stranger (Seattle) for 'The Bravest Woman in Seattle,' "his haunting story of a woman who survived a brutal attack that took the life of her partner."
2013: John Branch of The New York Times, for 'Snow Fall', an "evocative narrative about skiers killed in an avalanche and the science that explains such disasters" and the integration of multimedia elements.
2014: not awarded
2015: Diana Marcum of the Los Angeles Times for Scenes from California's Dust Bowl "her dispatches from California's Central Valley offering nuanced portraits of lives affected by the state's drought, bringing an original and empathic perspective to the story."
2016: Kathryn Schulz of The New Yorker for The Really Big One, "an elegant scientific narrative of the rupturing of the Cascadia fault line, a masterwork of environmental reporting and writing."
2017: C. J. Chivers of The New York Times for 'The Fighter,' "showing, through an artful accumulation of fact and detail, that a Marine's postwar descent into violence reflected neither the actions of a simple criminal nor a stereotypical case of PTSD."
2018: Rachel Kaadzi Ghansah, freelance reporter, GQ, for "an unforgettable portrait of murderer Dylann Roof, using a unique and powerful mix of reportage, first-person reflection and analysis of the historical and cultural forces behind his killing of nine people inside Emanuel AME Church in Charleston, S.C."
2019: Hannah Dreier of ProPublica for a series of powerful, intimate narratives that followed Salvadoran immigrants on New York's Long Island whose lives were shattered by a botched federal crackdown on the international criminal gang MS-13.
2020: Ben Taub of The New Yorker for "a devastating account of a man who was kidnapped, tortured and deprived of his liberty for more than a decade at the Guantanamo Bay detention facility, blending on-the-ground reporting and lyrical prose to offer a nuanced perspective on America's wider war on terror." (Moved into contention by the Board.)
2021: Nadja Drost, freelance contributor, The California Sunday Magazine, for "For a brave and gripping account of global migration that documents a group's journey on foot through the Darién Gap, one of the most dangerous migrant routes in the world." Mitchell S. Jackson, freelance contributor for Runner's World, "for a deeply affecting account of the killing of Ahmaud Arbery that combined vivid writing, thorough reporting and personal experience to shed light on systemic racism in America."
2022: Jennifer Senior of The Atlantic, "For an unflinching portrait of a family's reckoning with loss in the 20 years since 9/11, masterfully braiding the author's personal connection to the story with sensitive reporting that reveals the long reach of grief."
2023: Eli Saslow of The Washington Post, "For evocative individual narratives about people struggling with the pandemic, homelessness, addiction and inequality that collectively form a sharply-observed portrait of contemporary America."
References
Feature Writing
Awards established in 1979
|
Marije van Hunenstijn (; born 2 March 1995) is a Dutch sprinter. She won a silver medal in the 4 × 100 metres relay at the 2018 European Championships.
In her youth she trained for gymnastics before turning to athletics at the age of 13.
International competitions
1Did not finish in the final
Personal bests
Outdoor
100 metres – 11.13 (+1.9 m/s, La Chaux-de-Fonds 2019)
200 metres – 23.25 (+0.0 m/s, Bruxelles 2019)
Indoor
60 metres – 7.34 (Karlsruhe 2019)
References
1995 births
Living people
Dutch female sprinters
Sportspeople from Apeldoorn
Athletes (track and field) at the 2020 Summer Olympics
Olympic female sprinters
Olympic athletes for the Netherlands
21st-century Dutch women
21st-century Dutch people
|
```c++
#define SOL_ALL_SAFETIES_ON 1
#include <sol/sol.hpp>
#include <iostream>
#include <unordered_map>
struct thing {
int member_variable = 5;
double member_function() const {
return member_variable / 2.0;
}
};
#define TEMPLATE_AUTO(x) decltype(x), x
// cheap storage: in reality, you'd need to find a
// better way of handling this.
// or not! It's up to you.
static std::unordered_map<sol::string_view, sol::object>
thing_function_associations;
static std::unordered_map<sol::string_view, sol::object>
thing_variable_associations;
void register_thing_type(sol::state& lua) {
thing_variable_associations.emplace_hint(
thing_variable_associations.cend(),
"member_variable",
sol::object(lua.lua_state(),
sol::in_place,
&sol::c_call<TEMPLATE_AUTO(
&thing::member_variable)>));
thing_function_associations.emplace_hint(
thing_function_associations.cend(),
"member_function",
sol::object(lua.lua_state(),
sol::in_place,
&sol::c_call<TEMPLATE_AUTO(
&thing::member_function)>));
struct call_handler {
static int lookup_function(lua_State* L) {
sol::stack_object source(L, 1);
sol::stack_object key(L, 2);
if (!source.is<thing>()) {
return luaL_error(L,
"given an incorrect object for this "
"call");
}
sol::optional<sol::string_view> maybe_svkey
= key.as<sol::optional<sol::string_view>>();
if (maybe_svkey) {
{
// functions are different from
// variables functions, when obtain with
// the syntax obj.f, obj.f(), and
// obj:f() must return the function
// itself so we just push it realy into
// our target
auto it
= thing_function_associations.find(
*maybe_svkey);
if (it
!= thing_function_associations
.cend()) {
return it->second.push(L);
}
}
{
// variables are different than funtions
// when someone does `obj.a`, they
// expect this __index call (this lookup
// function) to return to them the value
// itself they're seeing so we call out
// lua_CFunction that we serialized
// earlier
auto it
= thing_variable_associations.find(
*maybe_svkey);
if (it
!= thing_variable_associations
.cend()) {
// note that calls generated by
// sol2 for member variables expect
// the stack ordering to be 2(, 3,
// ..., n) -- value(s) 1 -- source
// so we destroy the key on the
// stack
sol::stack::remove(L, 2, 1);
lua_CFunction cf
= it->second
.as<lua_CFunction>();
return cf(L);
}
}
}
return sol::stack::push(L, sol::lua_nil);
}
static int insertion_function(lua_State* L) {
sol::stack_object source(L, 1);
sol::stack_object key(L, 2);
sol::stack_object value(L, 3);
if (!source.is<thing>()) {
return luaL_error(L,
"given an incorrect object for this "
"call");
}
// write to member variables, etc. etc...
sol::optional<sol::string_view> maybe_svkey
= key.as<sol::optional<sol::string_view>>();
if (maybe_svkey) {
{
// variables are different than funtions
// when someone does `obj.a`, they
// expect this __index call (this lookup
// function) to return to them the value
// itself they're seeing so we call out
// lua_CFunction that we serialized
// earlier
auto it
= thing_variable_associations.find(
*maybe_svkey);
if (it
!= thing_variable_associations
.cend()) {
// note that calls generated by
// sol2 for member variables expect
// the stack ordering to be 2(, 3,
// ..., n) -- value(s) 1 -- source
// so we remove the key value
sol::stack::remove(L, 2, 1);
lua_CFunction cf
= it->second
.as<lua_CFunction>();
return cf(L);
}
else {
// write to member variable, maybe
// override function if your class
// allows for it?
(void)value;
}
}
// exercise for reader:
// how do you override functions on the
// metatable with proper syntax, but error
// when the type is an "instance" object?
}
return 0;
}
};
lua.new_usertype<thing>("thing");
sol::table metatable = lua["thing"];
metatable[sol::meta_method::index]
= &call_handler::lookup_function;
metatable[sol::meta_method::new_index]
= &call_handler::insertion_function;
}
void unregister_thing_type(sol::state&) {
thing_function_associations.clear();
thing_variable_associations.clear();
}
int main() {
std::cout << "=== metatable with custom-built (static) "
"handling ==="
<< std::endl;
sol::state lua;
lua.open_libraries(sol::lib::base);
// register custom type + storage
register_thing_type(lua);
lua.script(R"(t = thing.new()
print(t.member_variable)
print(t:member_function())
t.member_variable = 24
print(t.member_variable)
print(t:member_function())
)");
// clear storage
unregister_thing_type(lua);
std::cout << std::endl;
return 0;
}
```
|
```python
from yowsup.layers.protocol_iq.protocolentities.iq import IqProtocolEntity
from yowsup.structs import ProtocolTreeNode
from yowsup.structs.protocolentity import ProtocolEntityTest
import unittest
class IqProtocolEntityTest(unittest.TestCase, ProtocolEntityTest):
def setUp(self):
self.ProtocolEntity = IqProtocolEntity
self.node = ProtocolTreeNode("iq", {"id": "test_id", "type": "get", "xmlns": "iq_xmlns"}, None, None)
```
|
```c
/***
*wcschr.c - search a wchar_t string for a given wchar_t character
*
*
*Purpose:
* defines wcschr() - search a wchar_t string for a wchar_t character
*
*******************************************************************************/
#include <vcruntime_internal.h>
#include <intrin.h>
#define XMM_SIZE sizeof(__m128i)
#define XMM_CHARS (XMM_SIZE / sizeof(wchar_t))
#define PAGE_SIZE ((intptr_t)0x1000)
#define PAGE_OFFSET(p) ((PAGE_SIZE-1) & (intptr_t)(p))
#define XMM_PAGE_SAFE(p) (PAGE_OFFSET(p) <= (PAGE_SIZE - XMM_SIZE))
/***
*wchar_t *wcschr(string, c) - search a string for a wchar_t character
*
*Purpose:
* Searches a wchar_t string for a given wchar_t character,
* which may be the null character L'\0'.
*
*Entry:
* wchar_t *str - wchar_t string to search in
* wchar_t ch - wchar_t character to search for
*
*Exit:
* returns pointer to the first occurrence of c in string
* returns NULL if c does not occur in string
*
*Exceptions:
*
*******************************************************************************/
wchar_t * __cdecl wcschr (
const wchar_t * str,
wchar_t ch
)
{
if (__isa_available < __ISA_AVAILABLE_SSE2)
{
while (*str && *str != ch)
str++;
// If the character is a match return pointer, otherwise
// it must be the terminating zero and return NULL.
return (*str == ch) ? (wchar_t *)str : NULL;
}
else
{
__m128i match, characters, temp;
unsigned mask;
unsigned long offset;
// Build match pattern with target character in every position.
match = _mm_cvtsi32_si128(ch);
match = _mm_shufflelo_epi16(match, 0);
match = _mm_shuffle_epi32(match, 0);
for (;;)
{
// If the next XMMWORD does not overlap a page boundary check
// it for match of character or zero.
if (XMM_PAGE_SAFE(str))
{
// Check for match with either the search or zero character.
// There may be more than one match, but only the first is
// significant.
characters = _mm_loadu_si128((__m128i*)str);
temp = _mm_xor_si128(temp, temp);
temp = _mm_cmpeq_epi16(temp, characters);
characters = _mm_cmpeq_epi16(characters, match);
temp = _mm_or_si128(temp, characters);
mask = _mm_movemask_epi8(temp);
// If one or more matches was found, get the position of
// the first one. If that character is the same as the
// search character return the pointer to it, otherwise
// it must be the terminating zero so return NULL.
if (mask != 0)
{
_BitScanForward(&offset, mask);
str = (wchar_t *)(offset + (intptr_t)str);
return (*str == ch) ? (wchar_t *)str : NULL;
}
// No match found in this XMMWORD so skip to next.
str += XMM_CHARS;
}
else
{
// If it is not safe to check an entire XMMWORD, check
// a single character and try again.
if (*str == ch) return (wchar_t *)str;
if (*str == 0) return NULL;
// No match so skip to next characcter.
++str;
}
}
}
}
```
|
```javascript
"use strict";
const config = require('config');
if (!config.roles) {
config.roles = config.defaultRoles;
}
module.exports = config;
```
|
Richard's pipit (Anthus richardi) is a medium-sized passerine bird which breeds in open grasslands in the East Palearctic. It is a long-distance migrant moving to open lowlands in the Indian subcontinent and Southeast Asia. It is a rare but regular vagrant to western Europe.
The genus name Anthus is the Latin name for a small bird of grasslands. The English name and richardi are for the French naturalist Charles Richard (1745–1835), director of postal services at Lunéville and friend of Francois Levaillant.
It belongs to the pipit genus Anthus in the family Motacillidae. It was formerly lumped together with the Australasian, African, mountain and paddyfield pipits in a single species: Richard's pipit, Anthus novaeseelandiae. These pipits are now commonly considered to be separate species although the African and paddyfield pipits are sometimes treated as part of A. richardi.
Description
This is a large pipit, 17–20 cm in length, with a weight of 25–36 g and a wingspan of 29 to 33 cm. It is a slender bird which often stands very upright. It has long yellow-brown legs, a long tail with white outer-feathers and a long dark bill with a yellowish base to the lower mandible. The hindclaw is long and fairly straight. It is an undistinguished-looking species on the ground, mainly brown above and pale below. There are dark streaks on the upperparts and breast while the belly and flanks are plain. The face is strongly marked with pale lores and supercilium and dark eyestripe, moustachial stripe and malar stripe. There are two wingbars formed by pale tips to the wing-coverts.
There is some variation between the different subspecies. A. r. sinensis is slightly smaller than the nominate race with less streaking above. A. r. centralasiae is larger with more sand-coloured upperparts. A. r. dauricus has more streaking above.
Its flight is strong and undulating, and it gives a characteristic explosive "shreep" call, somewhat similar to the chirp of a house sparrow. The song is a repeated series of monotonous buzzy notes given in an undulating song-flight.
Some care must be taken to distinguish this from other large pipits which winter or are resident in the area, such as Blyth's pipit and paddyfield pipit. Blyth's pipit has a shorter bill, legs and tail, a shorter and more curved hindclaw, less white on the tail and more streaking on the upperparts. In adult birds, the median wing-coverts have blunt-ended dark centres whereas in Richard's pipit the dark centres become pointed towards the tip of the feather. The call of Blyth's pipit call is quieter and less harsh. Paddyfield pipit is smaller than Richard's pipit with a shorter bill and tail, less streaking on the breast and a quieter call.
Distribution and habitat
Richard's pipit breeds in southern Siberia, Mongolia, parts of Central Asia and in northern, central and eastern China. It migrates south to winter in the Indian subcontinent and South-east Asia with records as far south as Sri Lanka, Singapore and northern Borneo. It is a scarce passage migrant in Korea and Japan. A small part of the population regularly moves west in autumn and birds have been recorded from most countries in Europe, the Middle East and North Africa. It is seen annually between September and November at coastal watchpoints in areas such as Britain, the Netherlands and Scandinavia with occasional birds appearing in spring. A few overwinter in countries like Spain, Portugal, Italy and Morocco.
Behaviour and ecology
It is a bird of open country, particularly flat lowland areas. It inhabits grassland, steppe and cultivated land, preferring more fertile, moist habitats. In Europe it is most often recorded on headlands and islands. It occurs alone or in small groups.
Like other pipits, this species is insectivorous. It mainly feeds on the ground and will also make short flights to catch flying insects. A few seeds are also eaten.
The nest is made of grass or moss and is built on the ground under a grass tussock.
References
External links
Richard's pipit
Birds of Asia
Richard's pipit
Richard's pipit
|
```smalltalk
using System;
namespace NPOI
{
[Serializable]
public class EncryptedDocumentException : InvalidOperationException
{
public EncryptedDocumentException(String s)
: base(s)
{ }
}
}
```
|
```php
<?php
/*
*
*
* path_to_url
*
* Unless required by applicable law or agreed to in writing, software
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
*/
namespace Google\Service\ManagedServiceforMicrosoftActiveDirectoryConsumerAPI;
class LDAPSSettings extends \Google\Model
{
protected $certificateType = Certificate::class;
protected $certificateDataType = '';
/**
* @var string
*/
public $certificatePassword;
/**
* @var string
*/
public $certificatePfx;
/**
* @var string
*/
public $name;
/**
* @var string
*/
public $state;
/**
* @var string
*/
public $updateTime;
/**
* @param Certificate
*/
public function setCertificate(Certificate $certificate)
{
$this->certificate = $certificate;
}
/**
* @return Certificate
*/
public function getCertificate()
{
return $this->certificate;
}
/**
* @param string
*/
public function setCertificatePassword($certificatePassword)
{
$this->certificatePassword = $certificatePassword;
}
/**
* @return string
*/
public function getCertificatePassword()
{
return $this->certificatePassword;
}
/**
* @param string
*/
public function setCertificatePfx($certificatePfx)
{
$this->certificatePfx = $certificatePfx;
}
/**
* @return string
*/
public function getCertificatePfx()
{
return $this->certificatePfx;
}
/**
* @param string
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* @param string
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return string
*/
public function getState()
{
return $this->state;
}
/**
* @param string
*/
public function setUpdateTime($updateTime)
{
$this->updateTime = $updateTime;
}
/**
* @return string
*/
public function getUpdateTime()
{
return $this->updateTime;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(LDAPSSettings::class, your_sha256_hashAPI_LDAPSSettings');
```
|
```c++
#include <IO/ReadHelpers.h>
#include <IO/ReadBufferFromString.h>
#include <IO/BufferWithOwnMemory.h>
#include <IO/Operators.h>
#include <Formats/verbosePrintString.h>
#include <Formats/registerWithNamesAndTypes.h>
#include <Formats/FormatFactory.h>
#include <Formats/ReadSchemaUtils.h>
#include <Formats/EscapingRuleUtils.h>
#include <Processors/Formats/Impl/CSVRowInputFormat.h>
#include <DataTypes/Serializations/SerializationNullable.h>
#include <DataTypes/DataTypeString.h>
#include <DataTypes/DataTypeNullable.h>
#include <Common/logger_useful.h>
namespace DB
{
namespace ErrorCodes
{
extern const int BAD_ARGUMENTS;
extern const int INCORRECT_DATA;
extern const int LOGICAL_ERROR;
}
namespace
{
void checkBadDelimiter(char delimiter, bool allow_whitespace_or_tab_as_delimiter)
{
if ((delimiter == ' ' || delimiter == '\t') && allow_whitespace_or_tab_as_delimiter)
{
return;
}
constexpr std::string_view bad_delimiters = " \t\"'.UL";
if (bad_delimiters.find(delimiter) != std::string_view::npos)
throw Exception(
ErrorCodes::BAD_ARGUMENTS,
"CSV format may not work correctly with delimiter '{}'. Try use CustomSeparated format instead",
delimiter);
}
}
CSVRowInputFormat::CSVRowInputFormat(
const Block & header_,
ReadBuffer & in_,
const Params & params_,
bool with_names_,
bool with_types_,
const FormatSettings & format_settings_)
: CSVRowInputFormat(
header_, std::make_shared<PeekableReadBuffer>(in_), params_, with_names_, with_types_, format_settings_)
{
}
CSVRowInputFormat::CSVRowInputFormat(
const Block & header_,
std::shared_ptr<PeekableReadBuffer> in_,
const Params & params_,
bool with_names_,
bool with_types_,
const FormatSettings & format_settings_,
std::unique_ptr<FormatWithNamesAndTypesReader> format_reader_)
: RowInputFormatWithNamesAndTypes(
header_,
*in_,
params_,
false,
with_names_,
with_types_,
format_settings_,
std::move(format_reader_),
format_settings_.csv.try_detect_header),
buf(std::move(in_))
{
checkBadDelimiter(format_settings_.csv.delimiter, format_settings_.csv.allow_whitespace_or_tab_as_delimiter);
}
CSVRowInputFormat::CSVRowInputFormat(
const Block & header_,
std::shared_ptr<PeekableReadBuffer> in_,
const Params & params_,
bool with_names_,
bool with_types_,
const FormatSettings & format_settings_)
: RowInputFormatWithNamesAndTypes(
header_,
*in_,
params_,
false,
with_names_,
with_types_,
format_settings_,
std::make_unique<CSVFormatReader>(*in_, format_settings_),
format_settings_.csv.try_detect_header),
buf(std::move(in_))
{
checkBadDelimiter(format_settings_.csv.delimiter, format_settings_.csv.allow_whitespace_or_tab_as_delimiter);
}
void CSVRowInputFormat::syncAfterError()
{
skipToNextLineOrEOF(*buf);
}
void CSVRowInputFormat::setReadBuffer(ReadBuffer & in_)
{
buf = std::make_unique<PeekableReadBuffer>(in_);
RowInputFormatWithNamesAndTypes::setReadBuffer(*buf);
}
void CSVRowInputFormat::resetReadBuffer()
{
buf.reset();
RowInputFormatWithNamesAndTypes::resetReadBuffer();
}
void CSVFormatReader::skipRow()
{
bool quotes = false;
ReadBuffer & istr = *buf;
while (!istr.eof())
{
if (quotes)
{
auto * pos = find_first_symbols<'"'>(istr.position(), istr.buffer().end());
istr.position() = pos;
if (pos > istr.buffer().end())
throw Exception(ErrorCodes::LOGICAL_ERROR, "Position in buffer is out of bounds. There must be a bug.");
else if (pos == istr.buffer().end())
continue;
else if (*pos == '"')
{
++istr.position();
if (!istr.eof() && *istr.position() == '"')
++istr.position();
else
quotes = false;
}
}
else
{
auto * pos = find_first_symbols<'"', '\r', '\n'>(istr.position(), istr.buffer().end());
istr.position() = pos;
if (pos > istr.buffer().end())
throw Exception(ErrorCodes::LOGICAL_ERROR, "Position in buffer is out of bounds. There must be a bug.");
else if (pos == istr.buffer().end())
continue;
if (*pos == '"')
{
quotes = true;
++istr.position();
continue;
}
if (*pos == '\n')
{
++istr.position();
if (!istr.eof() && *istr.position() == '\r')
++istr.position();
return;
}
else if (*pos == '\r')
{
++istr.position();
if (format_settings.csv.allow_cr_end_of_line)
return;
else if (!istr.eof() && *pos == '\n')
{
++pos;
return;
}
}
}
}
}
static void skipEndOfLine(ReadBuffer & in, bool allow_cr_end_of_line)
{
/// \n (Unix) or \r\n (DOS/Windows) or \n\r (Mac OS Classic)
if (*in.position() == '\n')
{
++in.position();
if (!in.eof() && *in.position() == '\r')
++in.position();
}
else if (*in.position() == '\r')
{
++in.position();
if (!in.eof() && *in.position() == '\n')
++in.position();
else if (!allow_cr_end_of_line)
throw Exception(ErrorCodes::INCORRECT_DATA,
"Cannot parse CSV format: found \\r (CR) not followed by \\n (LF)."
" Line must end by \\n (LF) or \\r\\n (CR LF) or \\n\\r.");
}
else if (!in.eof())
throw Exception(ErrorCodes::INCORRECT_DATA, "Expected end of line");
}
/// Skip `whitespace` symbols allowed in CSV.
static inline void skipWhitespacesAndTabs(ReadBuffer & in, const bool & allow_whitespace_or_tab_as_delimiter)
{
if (allow_whitespace_or_tab_as_delimiter)
{
return;
}
while (!in.eof() && (*in.position() == ' ' || *in.position() == '\t'))
++in.position();
}
CSVFormatReader::CSVFormatReader(PeekableReadBuffer & buf_, const FormatSettings & format_settings_) : FormatWithNamesAndTypesReader(buf_, format_settings_), buf(&buf_)
{
}
void CSVFormatReader::skipFieldDelimiter()
{
skipWhitespacesAndTabs(*buf, format_settings.csv.allow_whitespace_or_tab_as_delimiter);
assertChar(format_settings.csv.delimiter, *buf);
}
template <bool read_string>
String CSVFormatReader::readCSVFieldIntoString()
{
if (format_settings.csv.trim_whitespaces) [[likely]]
skipWhitespacesAndTabs(*buf, format_settings.csv.allow_whitespace_or_tab_as_delimiter);
String field;
if constexpr (read_string)
readCSVString(field, *buf, format_settings.csv);
else
readCSVField(field, *buf, format_settings.csv);
return field;
}
void CSVFormatReader::skipField()
{
skipWhitespacesAndTabs(*buf, format_settings.csv.allow_whitespace_or_tab_as_delimiter);
NullOutput out;
readCSVStringInto(out, *buf, format_settings.csv);
}
void CSVFormatReader::skipRowEndDelimiter()
{
skipWhitespacesAndTabs(*buf, format_settings.csv.allow_whitespace_or_tab_as_delimiter);
if (buf->eof())
return;
/// we support the extra delimiter at the end of the line
if (*buf->position() == format_settings.csv.delimiter)
++buf->position();
skipWhitespacesAndTabs(*buf, format_settings.csv.allow_whitespace_or_tab_as_delimiter);
if (buf->eof())
return;
skipEndOfLine(*buf, format_settings.csv.allow_cr_end_of_line);
}
void CSVFormatReader::skipHeaderRow()
{
do
{
skipField();
skipWhitespacesAndTabs(*buf, format_settings.csv.allow_whitespace_or_tab_as_delimiter);
} while (checkChar(format_settings.csv.delimiter, *buf));
skipRowEndDelimiter();
}
template <bool is_header>
std::vector<String> CSVFormatReader::readRowImpl()
{
std::vector<String> fields;
do
{
fields.push_back(readCSVFieldIntoString<is_header>());
skipWhitespacesAndTabs(*buf, format_settings.csv.allow_whitespace_or_tab_as_delimiter);
} while (checkChar(format_settings.csv.delimiter, *buf));
skipRowEndDelimiter();
return fields;
}
bool CSVFormatReader::parseFieldDelimiterWithDiagnosticInfo(WriteBuffer & out)
{
const char delimiter = format_settings.csv.delimiter;
try
{
skipWhitespacesAndTabs(*buf, format_settings.csv.allow_whitespace_or_tab_as_delimiter);
assertChar(delimiter, *buf);
}
catch (const DB::Exception &)
{
if (*buf->position() == '\n' || *buf->position() == '\r')
{
out << "ERROR: Line feed found where delimiter (" << delimiter
<< ") is expected."
" It's like your file has less columns than expected.\n"
"And if your file has the right number of columns, maybe it has unescaped quotes in values.\n";
}
else
{
out << "ERROR: There is no delimiter (" << delimiter << "). ";
verbosePrintString(buf->position(), buf->position() + 1, out);
out << " found instead.\n";
}
return false;
}
return true;
}
bool CSVFormatReader::parseRowEndWithDiagnosticInfo(WriteBuffer & out)
{
skipWhitespacesAndTabs(*buf, format_settings.csv.allow_whitespace_or_tab_as_delimiter);
if (buf->eof())
return true;
/// we support the extra delimiter at the end of the line
if (*buf->position() == format_settings.csv.delimiter)
{
++buf->position();
skipWhitespacesAndTabs(*buf, format_settings.csv.allow_whitespace_or_tab_as_delimiter);
if (buf->eof())
return true;
}
if (!buf->eof() && *buf->position() != '\n' && *buf->position() != '\r')
{
out << "ERROR: There is no line feed. ";
verbosePrintString(buf->position(), buf->position() + 1, out);
out << " found instead.\n"
" It's like your file has more columns than expected.\n"
"And if your file has the right number of columns, maybe it has an unquoted string value with a comma.\n";
return false;
}
skipEndOfLine(*buf, format_settings.csv.allow_cr_end_of_line);
return true;
}
bool CSVFormatReader::allowVariableNumberOfColumns() const
{
return format_settings.csv.allow_variable_number_of_columns;
}
bool CSVFormatReader::readField(
IColumn & column,
const DataTypePtr & type,
const SerializationPtr & serialization,
bool is_last_file_column,
const String & /*column_name*/)
{
if (format_settings.csv.trim_whitespaces || !isStringOrFixedString(removeNullable(type))) [[likely]]
skipWhitespacesAndTabs(*buf, format_settings.csv.allow_whitespace_or_tab_as_delimiter);
const bool at_delimiter = !buf->eof() && *buf->position() == format_settings.csv.delimiter;
const bool at_last_column_line_end = is_last_file_column && (buf->eof() || *buf->position() == '\n' || *buf->position() == '\r');
/// Note: Tuples are serialized in CSV as separate columns, but with empty_as_default or null_as_default
/// only one empty or NULL column will be expected
if (format_settings.csv.empty_as_default && (at_delimiter || at_last_column_line_end))
{
/// Treat empty unquoted column value as default value, if
/// specified in the settings. Tuple columns might seem
/// problematic, because they are never quoted but still contain
/// commas, which might be also used as delimiters. However,
/// they do not contain empty unquoted fields, so this check
/// works for tuples as well.
column.insertDefault();
return false;
}
if (format_settings.csv.use_default_on_bad_values)
return readFieldOrDefault(column, type, serialization);
return readFieldImpl(*buf, column, type, serialization);
}
bool CSVFormatReader::readFieldImpl(ReadBuffer & istr, DB::IColumn & column, const DB::DataTypePtr & type, const DB::SerializationPtr & serialization)
{
if (format_settings.null_as_default && !isNullableOrLowCardinalityNullable(type))
{
/// If value is null but type is not nullable then use default value instead.
return SerializationNullable::deserializeNullAsDefaultOrNestedTextCSV(column, istr, format_settings, serialization);
}
/// Read the column normally.
serialization->deserializeTextCSV(column, istr, format_settings);
return true;
}
bool CSVFormatReader::readFieldOrDefault(DB::IColumn & column, const DB::DataTypePtr & type, const DB::SerializationPtr & serialization)
{
String field;
readCSVField(field, *buf, format_settings.csv);
ReadBufferFromString tmp_buf(field);
bool is_bad_value = false;
bool res = false;
size_t col_size = column.size();
try
{
res = readFieldImpl(tmp_buf, column, type, serialization);
/// Check if we parsed the whole field successfully.
if (!field.empty() && !tmp_buf.eof())
is_bad_value = true;
}
catch (const Exception &)
{
is_bad_value = true;
}
if (!is_bad_value)
return res;
if (column.size() == col_size + 1)
column.popBack(1);
column.insertDefault();
return false;
}
void CSVFormatReader::skipPrefixBeforeHeader()
{
for (size_t i = 0; i != format_settings.csv.skip_first_lines; ++i)
readRow();
}
void CSVFormatReader::setReadBuffer(ReadBuffer & in_)
{
buf = assert_cast<PeekableReadBuffer *>(&in_);
FormatWithNamesAndTypesReader::setReadBuffer(*buf);
}
bool CSVFormatReader::checkForSuffix()
{
if (!format_settings.csv.skip_trailing_empty_lines)
return buf->eof();
PeekableReadBufferCheckpoint checkpoint(*buf);
while (checkChar('\n', *buf) || checkChar('\r', *buf));
if (buf->eof())
return true;
buf->rollbackToCheckpoint();
return false;
}
bool CSVFormatReader::checkForEndOfRow()
{
skipWhitespacesAndTabs(*buf, format_settings.csv.allow_whitespace_or_tab_as_delimiter);
return buf->eof() || *buf->position() == '\n' || *buf->position() == '\r';
}
CSVSchemaReader::CSVSchemaReader(ReadBuffer & in_, bool with_names_, bool with_types_, const FormatSettings & format_settings_)
: FormatWithNamesAndTypesSchemaReader(
buf,
format_settings_,
with_names_,
with_types_,
&reader,
getDefaultDataTypeForEscapingRule(FormatSettings::EscapingRule::CSV),
format_settings_.csv.try_detect_header)
, buf(in_)
, reader(buf, format_settings_)
{
}
std::optional<std::pair<std::vector<String>, DataTypes>> CSVSchemaReader::readRowAndGetFieldsAndDataTypes()
{
if (buf.eof())
return {};
auto fields = reader.readRow();
auto data_types = tryInferDataTypesByEscapingRule(fields, format_settings, FormatSettings::EscapingRule::CSV);
return std::make_pair(std::move(fields), std::move(data_types));
}
std::optional<DataTypes> CSVSchemaReader::readRowAndGetDataTypesImpl()
{
auto fields_with_types = readRowAndGetFieldsAndDataTypes();
if (!fields_with_types)
return {};
return std::move(fields_with_types->second);
}
void registerInputFormatCSV(FormatFactory & factory)
{
auto register_func = [&](const String & format_name, bool with_names, bool with_types)
{
factory.registerInputFormat(format_name, [with_names, with_types](
ReadBuffer & buf,
const Block & sample,
IRowInputFormat::Params params,
const FormatSettings & settings)
{
return std::make_shared<CSVRowInputFormat>(sample, buf, std::move(params), with_names, with_types, settings);
});
};
registerWithNamesAndTypes("CSV", register_func);
}
std::pair<bool, size_t> fileSegmentationEngineCSVImpl(ReadBuffer & in, DB::Memory<> & memory, size_t min_bytes, size_t min_rows, size_t max_rows, const FormatSettings & settings)
{
char * pos = in.position();
bool quotes = false;
bool need_more_data = true;
size_t number_of_rows = 0;
if (max_rows && (max_rows < min_rows))
max_rows = min_rows;
while (loadAtPosition(in, memory, pos) && need_more_data)
{
if (quotes)
{
pos = find_first_symbols<'"'>(pos, in.buffer().end());
if (pos > in.buffer().end())
throw Exception(ErrorCodes::LOGICAL_ERROR, "Position in buffer is out of bounds. There must be a bug.");
else if (pos == in.buffer().end())
continue;
else if (*pos == '"')
{
++pos;
if (loadAtPosition(in, memory, pos) && *pos == '"')
++pos;
else
quotes = false;
}
}
else
{
pos = find_first_symbols<'"', '\r', '\n'>(pos, in.buffer().end());
if (pos > in.buffer().end())
throw Exception(ErrorCodes::LOGICAL_ERROR, "Position in buffer is out of bounds. There must be a bug.");
else if (pos == in.buffer().end())
continue;
if (*pos == '"')
{
quotes = true;
++pos;
continue;
}
if (*pos == '\n')
{
++pos;
if (loadAtPosition(in, memory, pos) && *pos == '\r')
++pos;
}
else if (*pos == '\r')
{
++pos;
if (settings.csv.allow_cr_end_of_line)
continue;
else if (loadAtPosition(in, memory, pos) && *pos == '\n')
++pos;
else
continue;
}
++number_of_rows;
if ((number_of_rows >= min_rows)
&& ((memory.size() + static_cast<size_t>(pos - in.position()) >= min_bytes) || (number_of_rows == max_rows)))
need_more_data = false;
}
}
saveUpToPosition(in, memory, pos);
return {loadAtPosition(in, memory, pos), number_of_rows};
}
void registerFileSegmentationEngineCSV(FormatFactory & factory)
{
auto register_func = [&](const String & format_name, bool, bool)
{
static constexpr size_t min_rows = 3; /// Make it 3 for header auto detection (first 3 rows must be always in the same segment).
factory.registerFileSegmentationEngineCreator(format_name, [](const FormatSettings & settings) -> FormatFactory::FileSegmentationEngine
{
return [settings] (ReadBuffer & in, DB::Memory<> & memory, size_t min_bytes, size_t max_rows)
{
return fileSegmentationEngineCSVImpl(in, memory, min_bytes, min_rows, max_rows, settings);
};
});
};
registerWithNamesAndTypes("CSV", register_func);
markFormatWithNamesAndTypesSupportsSamplingColumns("CSV", factory);
}
void registerCSVSchemaReader(FormatFactory & factory)
{
auto register_func = [&](const String & format_name, bool with_names, bool with_types)
{
factory.registerSchemaReader(format_name, [with_names, with_types](ReadBuffer & buf, const FormatSettings & settings)
{
return std::make_shared<CSVSchemaReader>(buf, with_names, with_types, settings);
});
if (!with_types)
{
factory.registerAdditionalInfoForSchemaCacheGetter(format_name, [with_names](const FormatSettings & settings)
{
String result = getAdditionalFormatInfoByEscapingRule(settings, FormatSettings::EscapingRule::CSV);
if (!with_names)
result += fmt::format(", column_names_for_schema_inference={}, try_detect_header={}, skip_first_lines={}", settings.column_names_for_schema_inference, settings.csv.try_detect_header, settings.csv.skip_first_lines);
return result;
});
}
};
registerWithNamesAndTypes("CSV", register_func);
}
}
```
|
Finance & Development is a quarterly journal published by the International Monetary Fund (the IMF).
The journal publishes analysis on issues related to the financial system, monetary policy, economic development, poverty reduction, and other world economic issues.
Contributors
Contributors are both IMF staff and prominent international financial experts and finance academics.
Print and web editions are published quarterly in English, Arabic, Chinese, French, Russian, and Spanish.
References
External links
Finance & Development
Quarterly magazines published in the United States
International Monetary Fund
Business magazines published in the United States
Magazines established in 1964
Multilingual magazines
Quarterly journals
Economics journals
Multilingual journals
|
```ruby
class FregeRepl < Formula
desc "REPL (read-eval-print loop) for Frege"
homepage "path_to_url"
url "path_to_url"
version "1.4-SNAPSHOT"
sha256 your_sha256_hash
license "BSD-3-Clause"
revision 2
bottle do
rebuild 2
sha256 cellar: :any_skip_relocation, all: your_sha256_hash
end
# TODO: Switch to `openjdk` on next release.
depends_on "openjdk@17"
def install
rm(Dir["bin/*.bat"])
libexec.install "bin", "lib"
(bin/"frege-repl").write_env_script libexec/"bin/frege-repl", JAVA_HOME: Formula["openjdk@17"].opt_prefix
end
test do
assert_match "65536", pipe_output(bin/"frege-repl", "println $ 64*1024\n:quit\n")
end
end
```
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.