~ubuntu-branches/ubuntu/intrepid/perl-doc-html/intrepid

<div id="contentBody"><div class="title_container"><div class="page_title">perlintern</div></div><ul><li><a href="#NAME">NAME</a><li><a href="#DESCRIPTION-internal-Perl-functions-interpreter-functions">DESCRIPTION

</a><li><a href="#CV-reference-counts-and-CvOUTSIDE">CV reference counts and CvOUTSIDE</a><li><a href="#Functions-in-file-pad.h">Functions in file pad.h</a><li><a href="#Functions-in-file-pp_ctl.c">Functions in file pp_ctl.c</a><li><a href="#Global-Variables">Global Variables</a><li><a href="#GV-Functions">GV Functions</a><li><a href="#IO-Functions">IO Functions</a><li><a href="#Pad-Data-Structures">Pad Data Structures</a><li><a href="#Stack-Manipulation-Macros">Stack Manipulation Macros</a><li><a href="#SV-Manipulation-Functions">SV Manipulation Functions</a><li><a href="#AUTHORS">AUTHORS</a><li><a href="#SEE-ALSO">SEE ALSO</a></ul><a name="NAME"></a><h1>NAME</h1>

<div id="contentBody"><div class="title_container"><div class="page_title">perlintern</div></div><ul><li><a href="#NAME">NAME</a><li><a href="#DESCRIPTION">DESCRIPTION

</a><li><a href="#CV-reference-counts-and-CvOUTSIDE">CV reference counts and CvOUTSIDE</a><li><a href="#Functions-in-file-pad.h">Functions in file pad.h</a><li><a href="#GV-Functions">GV Functions</a><li><a href="#Hash-Manipulation-Functions">Hash Manipulation Functions</a><li><a href="#IO-Functions">IO Functions</a><li><a href="#Magical-Functions">Magical Functions</a><li><a href="#MRO-Functions">MRO Functions</a><li><a href="#Pad-Data-Structures">Pad Data Structures</a><li><a href="#Per-Interpreter-Variables">Per-Interpreter Variables</a><li><a href="#Stack-Manipulation-Macros">Stack Manipulation Macros</a><li><a href="#SV-Manipulation-Functions">SV Manipulation Functions</a><li><a href="#SV-Body-Allocation">SV-Body Allocation</a><li><a href="#Unicode-Support">Unicode Support</a><li><a href="#AUTHORS">AUTHORS</a><li><a href="#SEE-ALSO">SEE ALSO</a></ul><a name="NAME"></a><h1>NAME</h1>

perlintern - autogenerated documentation of purely internal

Perl functions

<a name="DESCRIPTION-internal-Perl-functions-interpreter-functions"></a><h1>DESCRIPTION

<a name="DESCRIPTION"></a><h1>DESCRIPTION

</h1>

This file is the autogenerated documentation of functions in the

Perl interpreter that are documented using Perl's internal documentation

they are not for use in extensions!

<a name="CV-reference-counts-and-CvOUTSIDE"></a><h1>CV reference counts and CvOUTSIDE</h1>

<ul>

<li><a name="CvWEAKOUTSIDE-CvWEAKOUTSIDE"></a>CvWEAKOUTSIDE

<li><a name="CvWEAKOUTSIDE"></a>CvWEAKOUTSIDE

100

101

Each CV has a pointer, <code class="inline">CvOUTSIDE()</code>

102

, to its lexically enclosing

102

105

pad slots, it is a possible to get a circular reference,

103

106

with the parent pointing to the child and vice-versa. To avoid the

104

107

ensuing memory leak, we do not increment the reference count of the CV

105

pointed to by <code class="inline">CvOUTSIDE</code>

108

pointed to by <code class="inline">CvOUTSIDE</code>

106

109

in the one specific instance that the parent

107

110

has a <code class="inline">&</code>

108

111

pad slot pointing back to us. In this case, we set the

109

<code class="inline">CvWEAKOUTSIDE</code>

112

<code class="inline">CvWEAKOUTSIDE</code>

110

113

flag in the child. This allows us to determine under what

111

114

circumstances we should decrement the refcount of the parent when freeing

112

115

the child.

118

121

<pre class="verbatim"> BEGIN { $a = <a class="l_k" href="functions/sub.html">sub</a> { <a class="l_k" href="functions/eval.html">eval</a> '$x' } }</pre>

119

122

In this case, the BEGIN is freed immediately after execution since there

120

123

are no active references to it: the anon sub prototype has

121

<code class="inline">CvWEAKOUTSIDE</code>

124

<code class="inline">CvWEAKOUTSIDE</code>

122

125

set since it's not a closure, and $a points to the same

123

126

CV, so it doesn't contribute to BEGIN's refcount either. When $a is

124

127

executed, the <code class="inline"><a class="l_k" href="functions/eval.html">eval</a> '$x'</code>

125

causes the chain of <code class="inline">CvOUTSIDE</code>

128

causes the chain of <code class="inline">CvOUTSIDE</code>

126

129

s to be followed,

127

130

and the freed BEGIN is accessed.

128

131

To avoid this, whenever a CV and its associated pad is freed, any

129

132

130

133

entries in the pad are explicitly removed from the pad, and if the

131

134

refcount of the pointed-to anon sub is still positive, then that

132

child's <code class="inline">CvOUTSIDE</code>

135

child's <code class="inline">CvOUTSIDE</code>

133

136

is set to point to its grandparent. This will only

134

137

occur in the single specific case of a non-closure anon prototype

135

138

having one or more active references (such as <code class="inline">$a</code>

137

140

One other thing to consider is that a CV may be merely undefined

138

141

rather than freed, eg <code class="inline"><a class="l_k" href="functions/undef.html">undef</a> &foo</code>

139

142

. In this case, its refcount may

140

not have reached zero, but we still delete its pad and its <code class="inline">CvROOT</code>

143

not have reached zero, but we still delete its pad and its <code class="inline">CvROOT</code>

141

144

etc.

142

Since various children may still have their <code class="inline">CvOUTSIDE</code>

145

Since various children may still have their <code class="inline">CvOUTSIDE</code>

143

146

pointing at this

144

undefined CV, we keep its own <code class="inline">CvOUTSIDE</code>

147

undefined CV, we keep its own <code class="inline">CvOUTSIDE</code>

145

148

for the time being, so that

146

149

the chain of lexical scopes is unbroken. For example, the following

147

150

should print 123:

150

153

<a class="l_k" href="functions/my.html">my</a> $a = tmp();

151

154

<a class="l_k" href="functions/undef.html">undef</a> &tmp;

152

155

<a class="l_k" href="functions/print.html">print</a> $a->();</pre>

153

<pre class="verbatim"> bool CvWEAKOUTSIDE(CV *cv)</pre>

156

<pre class="verbatim"> bool CvWEAKOUTSIDE(CV *cv)</pre>

154

157

</li>

155

158

</ul>

156

159

<a name="Functions-in-file-pad.h"></a><h1>Functions in file pad.h</h1>

157

160

<ul>

158

<li><a name="CX_CURPAD_SAVE-CX_CURPAD_SAVE"></a>CX_CURPAD_SAVE

161

<li><a name="CX_CURPAD_SAVE"></a>CX_CURPAD_SAVE

159

162

160

163

Save the current pad in the given context block structure.

161

<pre class="verbatim"> void CX_CURPAD_SAVE(struct context)</pre>

164

<pre class="verbatim"> void CX_CURPAD_SAVE(struct context)</pre>

162

165

</li>

163

<li><a name="CX_CURPAD_SV-CX_CURPAD_SV"></a>CX_CURPAD_SV

166

<li><a name="CX_CURPAD_SV"></a>CX_CURPAD_SV

164

167

165

168

Access the SV at offset po in the saved current pad in the given

166

169

context block structure (can be used as an lvalue).

167

<pre class="verbatim"> SV * CX_CURPAD_SV(struct context, PADOFFSET po)</pre>

170

<pre class="verbatim"> SV * CX_CURPAD_SV(struct context, PADOFFSET po)</pre>

168

171

</li>

169

<li><a name="PAD_BASE_SV-PAD_BASE_SV"></a>PAD_BASE_SV

172

<li><a name="PAD_BASE_SV"></a>PAD_BASE_SV

170

173

171

Get the value from slot <code class="inline">po</code>

174

Get the value from slot <code class="inline">po</code>

172

175

in the base (DEPTH=1) pad of a padlist

173

<pre class="verbatim"> SV * PAD_BASE_SV(PADLIST padlist, PADOFFSET po)</pre>

176

<pre class="verbatim"> SV * PAD_BASE_SV(PADLIST padlist, PADOFFSET po)</pre>

174

177

</li>

175

<li><a name="PAD_CLONE_VARS-PAD_CLONE_VARS"></a>PAD_CLONE_VARS

178

<li><a name="PAD_CLONE_VARS"></a>PAD_CLONE_VARS

176

179

177

180

|CLONE_PARAMS* param

178

181

Clone the state variables associated with running and compiling pads.

179

<pre class="verbatim"> void PAD_CLONE_VARS(PerlInterpreter *proto_perl \)</pre>

182

<pre class="verbatim"> void PAD_CLONE_VARS(PerlInterpreter *proto_perl \)</pre>

180

183

</li>

181

<li><a name="PAD_COMPNAME_FLAGS-PAD_COMPNAME_FLAGS"></a>PAD_COMPNAME_FLAGS

184

<li><a name="PAD_COMPNAME_FLAGS"></a>PAD_COMPNAME_FLAGS

182

185

183

186

Return the flags for the current compiling pad name

184

at offset <code class="inline">po</code>

187

at offset <code class="inline">po</code>

185

188

. Assumes a valid slot entry.

186

<pre class="verbatim"> U32 PAD_COMPNAME_FLAGS(PADOFFSET po)</pre>

187

</li>

188

<li><a name="PAD_COMPNAME_GEN-PAD_COMPNAME_GEN"></a>PAD_COMPNAME_GEN

189

190

The generation number of the name at offset <code class="inline">po</code>

191

in the current

192

compiling pad (lvalue). Note that <code class="inline">SvCUR</code>

193

is hijacked for this purpose.

194

<pre class="verbatim"> STRLEN PAD_COMPNAME_GEN(PADOFFSET po)</pre>

195

</li>

196

<li><a name="PAD_COMPNAME_GEN_set-PAD_COMPNAME_GEN_set"></a>PAD_COMPNAME_GEN_set

197

198

Sets the generation number of the name at offset <code class="inline">po</code>

199

in the current

200

ling pad (lvalue) to <code class="inline">gen</code>

201

. Note that <code class="inline">SvCUR_set</code>

202

is hijacked for this purpose.

203

<pre class="verbatim"> STRLEN PAD_COMPNAME_GEN_set(PADOFFSET po, <a class="l_k" href="functions/int.html">int</a> gen)</pre>

204

</li>

205

<li><a name="PAD_COMPNAME_OURSTASH-PAD_COMPNAME_OURSTASH"></a>PAD_COMPNAME_OURSTASH

189

<pre class="verbatim"> U32 PAD_COMPNAME_FLAGS(PADOFFSET po)</pre>

190

</li>

191

<li><a name="PAD_COMPNAME_GEN"></a>PAD_COMPNAME_GEN

192

193

The generation number of the name at offset <code class="inline">po</code>

194

in the current

195

compiling pad (lvalue). Note that <code class="inline">SvUVX</code>

196

is hijacked for this purpose.

197

<pre class="verbatim"> STRLEN PAD_COMPNAME_GEN(PADOFFSET po)</pre>

198

</li>

199

<li><a name="PAD_COMPNAME_GEN_set"></a>PAD_COMPNAME_GEN_set

200

201

Sets the generation number of the name at offset <code class="inline">po</code>

202

in the current

203

ling pad (lvalue) to <code class="inline">gen</code>

204

. Note that <code class="inline">SvUV_set</code>

205

is hijacked for this purpose.

206

<pre class="verbatim"> STRLEN PAD_COMPNAME_GEN_set(PADOFFSET po, <a class="l_k" href="functions/int.html">int</a> gen)</pre>

207

</li>

208

<li><a name="PAD_COMPNAME_OURSTASH"></a>PAD_COMPNAME_OURSTASH

206

209

207

210

Return the stash associated with an <code class="inline"><a class="l_k" href="functions/our.html">our</a></code> variable.

208

211

Assumes the slot entry is a valid <code class="inline"><a class="l_k" href="functions/our.html">our</a></code> lexical.

209

<pre class="verbatim"> HV * PAD_COMPNAME_OURSTASH(PADOFFSET po)</pre>

212

<pre class="verbatim"> HV * PAD_COMPNAME_OURSTASH(PADOFFSET po)</pre>

210

213

</li>

211

<li><a name="PAD_COMPNAME_PV-PAD_COMPNAME_PV"></a>PAD_COMPNAME_PV

214

<li><a name="PAD_COMPNAME_PV"></a>PAD_COMPNAME_PV

212

215

213

216

Return the name of the current compiling pad name

214

at offset <code class="inline">po</code>

217

at offset <code class="inline">po</code>

215

218

. Assumes a valid slot entry.

216

<pre class="verbatim"> char * PAD_COMPNAME_PV(PADOFFSET po)</pre>

219

<pre class="verbatim"> char * PAD_COMPNAME_PV(PADOFFSET po)</pre>

217

220

</li>

218

<li><a name="PAD_COMPNAME_TYPE-PAD_COMPNAME_TYPE"></a>PAD_COMPNAME_TYPE

221

<li><a name="PAD_COMPNAME_TYPE"></a>PAD_COMPNAME_TYPE

219

222

220

223

Return the type (stash) of the current compiling pad name at offset

221

224

222

225

. Must be a valid name. Returns null if not typed.

223

<pre class="verbatim"> HV * PAD_COMPNAME_TYPE(PADOFFSET po)</pre>

226

<pre class="verbatim"> HV * PAD_COMPNAME_TYPE(PADOFFSET po)</pre>

224

227

</li>

225

<li><a name="PAD_DUP-PAD_DUP"></a>PAD_DUP

228

<li><a name="PAD_DUP"></a>PAD_DUP

226

229

227

230

Clone a padlist.

228

<pre class="verbatim"> void PAD_DUP(PADLIST dstpad, PADLIST srcpad, CLONE_PARAMS* param)</pre>

231

<pre class="verbatim"> void PAD_DUP(PADLIST dstpad, PADLIST srcpad, CLONE_PARAMS* param)</pre>

229

232

</li>

230

<li><a name="PAD_RESTORE_LOCAL-PAD_RESTORE_LOCAL"></a>PAD_RESTORE_LOCAL

233

<li><a name="PAD_RESTORE_LOCAL"></a>PAD_RESTORE_LOCAL

231

234

232

235

Restore the old pad saved into the local variable opad by PAD_SAVE_LOCAL()

233

<pre class="verbatim"> void PAD_RESTORE_LOCAL(PAD *opad)</pre>

236

<pre class="verbatim"> void PAD_RESTORE_LOCAL(PAD *opad)</pre>

234

237

</li>

235

<li><a name="PAD_SAVE_LOCAL-PAD_SAVE_LOCAL"></a>PAD_SAVE_LOCAL

238

<li><a name="PAD_SAVE_LOCAL"></a>PAD_SAVE_LOCAL

236

239

237

240

Save the current pad to the local variable opad, then make the

238

241

current pad equal to npad

239

<pre class="verbatim"> void PAD_SAVE_LOCAL(PAD *opad, PAD *npad)</pre>

242

<pre class="verbatim"> void PAD_SAVE_LOCAL(PAD *opad, PAD *npad)</pre>

240

243

</li>

241

<li><a name="PAD_SAVE_SETNULLPAD-PAD_SAVE_SETNULLPAD"></a>PAD_SAVE_SETNULLPAD

244

<li><a name="PAD_SAVE_SETNULLPAD"></a>PAD_SAVE_SETNULLPAD

242

245

243

246

Save the current pad then set it to null.

244

<pre class="verbatim"> void PAD_SAVE_SETNULLPAD()</pre>

247

<pre class="verbatim"> void PAD_SAVE_SETNULLPAD()</pre>

245

248

</li>

246

<li><a name="PAD_SETSV-PAD_SETSV"></a>PAD_SETSV

249

<li><a name="PAD_SETSV"></a>PAD_SETSV

247

250

248

Set the slot at offset <code class="inline">po</code>

249

in the current pad to <code class="inline">sv</code>

251

Set the slot at offset <code class="inline">po</code>

252

in the current pad to <code class="inline">sv</code>

250

253

251

<pre class="verbatim"> SV * PAD_SETSV(PADOFFSET po, SV* sv)</pre>

254

<pre class="verbatim"> SV * PAD_SETSV(PADOFFSET po, SV* sv)</pre>

252

255

</li>

253

<li><a name="PAD_SET_CUR-PAD_SET_CUR"></a>PAD_SET_CUR

256

<li><a name="PAD_SET_CUR"></a>PAD_SET_CUR

254

257

255

Set the current pad to be pad <code class="inline">n</code>

258

Set the current pad to be pad <code class="inline">n</code>

256

259

in the padlist, saving

257

260

the previous current pad. NB currently this macro expands to a string too

258

261

long for some compilers, so it's best to replace it with

259

262

<pre class="verbatim"> SAVECOMPPAD();

260

PAD_SET_CUR_NOSAVE(padlist,n);</pre>

261

<pre class="verbatim"> void PAD_SET_CUR(PADLIST padlist, I32 n)</pre>

263

PAD_SET_CUR_NOSAVE(padlist,n);</pre>

264

<pre class="verbatim"> void PAD_SET_CUR(PADLIST padlist, I32 n)</pre>

262

265

</li>

263

<li><a name="PAD_SET_CUR_NOSAVE-PAD_SET_CUR_NOSAVE"></a>PAD_SET_CUR_NOSAVE

266

<li><a name="PAD_SET_CUR_NOSAVE"></a>PAD_SET_CUR_NOSAVE

264

267

265

268

like PAD_SET_CUR, but without the save

266

<pre class="verbatim"> void PAD_SET_CUR_NOSAVE(PADLIST padlist, I32 n)</pre>

269

<pre class="verbatim"> void PAD_SET_CUR_NOSAVE(PADLIST padlist, I32 n)</pre>

267

270

</li>

268

<li><a name="PAD_SV-PAD_SV"></a>PAD_SV

271

<li><a name="PAD_SV"></a>PAD_SV

269

272

270

Get the value at offset <code class="inline">po</code>

273

Get the value at offset <code class="inline">po</code>

271

274

in the current pad

272

<pre class="verbatim"> void PAD_SV(PADOFFSET po)</pre>

275

<pre class="verbatim"> void PAD_SV(PADOFFSET po)</pre>

273

276

</li>

274

<li><a name="PAD_SVl-PAD_SVl"></a>PAD_SVl

277

<li><a name="PAD_SVl"></a>PAD_SVl

275

278

276

Lightweight and lvalue version of <code class="inline">PAD_SV</code>

279

Lightweight and lvalue version of <code class="inline">PAD_SV</code>

277

280

278

Get or set the value at offset <code class="inline">po</code>

281

Get or set the value at offset <code class="inline">po</code>

279

282

in the current pad.

280

Unlike <code class="inline">PAD_SV</code>

283

Unlike <code class="inline">PAD_SV</code>

281

284

, does not print diagnostics with -DX.

282

285

For internal use only.

283

<pre class="verbatim"> SV * PAD_SVl(PADOFFSET po)</pre>

286

<pre class="verbatim"> SV * PAD_SVl(PADOFFSET po)</pre>

284

287

</li>

285

<li><a name="SAVECLEARSV-SAVECLEARSV"></a>SAVECLEARSV

288

<li><a name="SAVECLEARSV"></a>SAVECLEARSV

286

289

287

290

Clear the pointed to pad value on scope exit. (i.e. the runtime action of 'my')

288

<pre class="verbatim"> void SAVECLEARSV(SV **svp)</pre>

291

<pre class="verbatim"> void SAVECLEARSV(SV **svp)</pre>

289

292

</li>

290

<li><a name="SAVECOMPPAD-SAVECOMPPAD"></a>SAVECOMPPAD

293

<li><a name="SAVECOMPPAD"></a>SAVECOMPPAD

291

294

292

295

save PL_comppad and PL_curpad

293

<pre class="verbatim"> void SAVECOMPPAD()</pre>

296

<pre class="verbatim"> void SAVECOMPPAD()</pre>

294

297

</li>

295

<li><a name="SAVEPADSV-SAVEPADSV"></a>SAVEPADSV

298

<li><a name="SAVEPADSV"></a>SAVEPADSV

296

299

297

300

Save a pad slot (used to restore after an iteration)

298

301

XXX DAPM it would make more sense to make the arg a PADOFFSET

299

302

void SAVEPADSV(PADOFFSET po)

300

303

</li>

301

304

</ul>

302

<a name="Functions-in-file-pp_ctl.c"></a><h1>Functions in file pp_ctl.c</h1>

303

<ul>

304

<li><a name="find_runcv-find_runcv"></a>find_runcv

305

306

Locate the CV corresponding to the currently executing sub or eval.

307

If db_seqp is non_null, skip CVs that are in the DB package and populate

308

*db_seqp with the cop sequence number at the point that the DB:: code was

309

entered. (allows debuggers to eval in the scope of the breakpoint rather

310

than in the scope of the debugger itself).

311

<pre class="verbatim"> CV* find_runcv(U32 *db_seqp)</pre>

312

</li>

313

</ul>

314

<a name="Global-Variables"></a><h1>Global Variables</h1>

315

<ul>

316

<li><a name="PL_DBsingle-PL_DBsingle"></a>PL_DBsingle

317

318

When Perl is run in debugging mode, with the -d switch, this SV is a

319

boolean which indicates whether subs are being single-stepped.

320

Single-stepping is automatically turned on after every step. This is the C

321

variable which corresponds to Perl's $DB::single variable. See

322

<code class="inline">PL_DBsub</code>

323

.

324

<pre class="verbatim"> SV * PL_DBsingle</pre>

325

</li>

326

<li><a name="PL_DBsub-PL_DBsub"></a>PL_DBsub

327

328

When Perl is run in debugging mode, with the -d switch, this GV contains

329

the SV which holds the name of the sub being debugged. This is the C

330

variable which corresponds to Perl's $DB::sub variable. See

331

<code class="inline">PL_DBsingle</code>

332

.

333

<pre class="verbatim"> GV * PL_DBsub</pre>

334

</li>

335

<li><a name="PL_DBtrace-PL_DBtrace"></a>PL_DBtrace

336

337

Trace variable used when Perl is run in debugging mode, with the -d

338

switch. This is the C variable which corresponds to Perl's $DB::trace

339

variable. See <code class="inline">PL_DBsingle</code>

340

.

341

<pre class="verbatim"> SV * PL_DBtrace</pre>

342

</li>

343

<li><a name="PL_dowarn-PL_dowarn"></a>PL_dowarn

344

345

The C variable which corresponds to Perl's $^W warning variable.

346

<pre class="verbatim"> bool PL_dowarn</pre>

347

</li>

348

<li><a name="PL_last_in_gv-PL_last_in_gv"></a>PL_last_in_gv

349

350

The GV which was last used for a filehandle input operation. (<code class="inline"><FH></code>

351

)

352

353

</li>

354

<li><a name="PL_ofs_sv-PL_ofs_sv"></a>PL_ofs_sv

355

356

The output field separator - <code class="inline">$,</code>

357

in Perl space.

358

359

</li>

360

<li><a name="PL_rs-PL_rs"></a>PL_rs

361

362

The input record separator - <code class="inline">$/</code>

363

in Perl space.

364

365

</li>

366

</ul>

367

305

<a name="GV-Functions"></a><h1>GV Functions</h1>

368

306

<ul>

369

<li><a name="is_gv_magical-is_gv_magical"></a>is_gv_magical

307

<li><a name="is_gv_magical"></a>is_gv_magical

370

308

371

Returns <code class="inline">TRUE</code>

309

Returns <code class="inline">TRUE</code>

372

310

if given the name of a magical GV.

373

311

Currently only useful internally when determining if a GV should be

374

312

created even in rvalue contexts.

375

<code class="inline">flags</code>

313

<code class="inline">flags</code>

376

314

is not used at present but available for future extension to

377

315

allow selecting particular classes of magical variable.

378

Currently assumes that <code class="inline">name</code>

316

Currently assumes that <code class="inline">name</code>

379

317

is NUL terminated (as well as len being valid).

380

318

This assumption is met by all callers within the perl core, which all pass

381

319

pointers returned by SvPV.

382

<pre class="verbatim"> bool is_gv_magical(char *name, STRLEN len, U32 flags)</pre>

320

<pre class="verbatim"> bool is_gv_magical(const char *name, STRLEN len, U32 flags)</pre>

321

</li>

322

<li><a name="is_gv_magical_sv"></a>is_gv_magical_sv

323

324

Returns <code class="inline">TRUE</code>

325

if given the name of a magical GV. Calls is_gv_magical.

326

<pre class="verbatim"> bool is_gv_magical_sv(SV *name, U32 flags)</pre>

327

</li>

328

</ul>

329

<a name="Hash-Manipulation-Functions"></a><h1>Hash Manipulation Functions</h1>

330

<ul>

331

<li><a name="refcounted_he_chain_2hv"></a>refcounted_he_chain_2hv

332

333

Generates and returns a <code class="inline">HV *</code>

334

by walking up the tree starting at the passed

335

in <code class="inline">struct refcounted_he *</code>

336

.

337

<pre class="verbatim"> HV * refcounted_he_chain_2hv(const struct refcounted_he *c)</pre>

338

</li>

339

<li><a name="refcounted_he_free"></a>refcounted_he_free

340

341

Decrements the reference count of the passed in <code class="inline">struct refcounted_he *</code>

342

343

by one. If the reference count reaches zero the structure's memory is freed,

344

and <code class="inline">refcounted_he_free</code>

345

iterates onto the parent node.

346

<pre class="verbatim"> void refcounted_he_free(struct refcounted_he *he)</pre>

347

</li>

348

<li><a name="refcounted_he_new"></a>refcounted_he_new

349

350

Creates a new <code class="inline">struct refcounted_he</code>

351

. As key is copied, and value is

352

stored in a compact form, all references remain the property of the caller.

353

The <code class="inline">struct refcounted_he</code>

354

is returned with a reference count of 1.

355

<pre class="verbatim"> struct refcounted_he * refcounted_he_new(struct refcounted_he *const parent, SV *const key, SV *const value)</pre>

383

356

</li>

384

357

</ul>

385

358

<a name="IO-Functions"></a><h1>IO Functions</h1>

386

359

<ul>

387

<li><a name="start_glob-start_glob"></a>start_glob

360

<li><a name="start_glob"></a>start_glob

388

361

389

Function called by <code class="inline">do_readline</code>

362

Function called by <code class="inline">do_readline</code>

390

363

to spawn a glob (or do the glob inside

391

perl on VMS). This code used to be inline, but now perl uses <code class="inline"><a class="l_w" href="File/Glob.html">File::Glob</a></code>

364

perl on VMS). This code used to be inline, but now perl uses <code class="inline">File::Glob</code>

365

392

366

this glob starter is only used by miniperl during the build process.

393

367

Moving it away shrinks pp_hot.c; shrinking pp_hot.c helps speed perl up.

394

<pre class="verbatim"> <a class="l_w" href="PerlIO.html">PerlIO</a>* start_glob(SV* pattern, <a class="l_w" href="IO.html">IO</a> *io)</pre>

368

<pre class="verbatim"> PerlIO* start_glob(SV* pattern, IO *io)</pre>

369

</li>

370

</ul>

371

<a name="Magical-Functions"></a><h1>Magical Functions</h1>

372

<ul>

373

<li><a name="magic_sethint"></a>magic_sethint

374

375

Triggered by a delete from %^H, records the key to

376

<code class="inline">PL_compiling.cop_hints_hash</code>

377

.

378

<pre class="verbatim"> <a class="l_k" href="functions/int.html">int</a> magic_sethint(SV* sv, MAGIC* mg)</pre>

379

</li>

380

<li><a name="mg_localize"></a>mg_localize

381

382

Copy some of the magic from an existing SV to new localized version of

383

that SV. Container magic (eg %ENV, $1, tie) gets copied, value magic

384

doesn't (eg taint, pos).

385

<pre class="verbatim"> void mg_localize(SV* sv, SV* nsv)</pre>

386

</li>

387

</ul>

388

<a name="MRO-Functions"></a><h1>MRO Functions</h1>

389

<ul>

390

<li><a name="mro_get_linear_isa_c3"></a>mro_get_linear_isa_c3

391

392

Returns the C3 linearization of @ISA

393

the given stash. The return value is a read-only AV*.

394

<code class="inline">level</code>

395

should be 0 (it is used internally in this

396

function's recursion).

397

You are responsible for <code class="inline">SvREFCNT_inc()</code>

398

on the

399

return value if you plan to store it anywhere

400

semi-permanently (otherwise it might be deleted

401

out from under you the next time the cache is

402

invalidated).

403

<pre class="verbatim"> AV* mro_get_linear_isa_c3(HV* stash, I32 level)</pre>

404

</li>

405

<li><a name="mro_get_linear_isa_dfs"></a>mro_get_linear_isa_dfs

406

407

Returns the Depth-First Search linearization of @ISA

408

the given stash. The return value is a read-only AV*.

409

<code class="inline">level</code>

410

should be 0 (it is used internally in this

411

function's recursion).

412

You are responsible for <code class="inline">SvREFCNT_inc()</code>

413

on the

414

return value if you plan to store it anywhere

415

semi-permanently (otherwise it might be deleted

416

out from under you the next time the cache is

417

invalidated).

418

<pre class="verbatim"> AV* mro_get_linear_isa_dfs(HV* stash, I32 level)</pre>

419

</li>

420

<li><a name="mro_isa_changed_in"></a>mro_isa_changed_in

421

422

Takes the necessary steps (cache invalidations, mostly)

423

when the @ISA of the given package has changed. Invoked

424

by the <code class="inline">setisa</code>

425

magic, should not need to invoke directly.

426

<pre class="verbatim"> void mro_isa_changed_in(HV* stash)</pre>

395

427

</li>

396

428

</ul>

397

429

<a name="Pad-Data-Structures"></a><h1>Pad Data Structures</h1>

398

430

<ul>

399

<li><a name="CvPADLIST-CvPADLIST"></a>CvPADLIST

431

<li><a name="CvPADLIST"></a>CvPADLIST

400

432

401

433

CV's can have CvPADLIST(cv) set to point to an AV.

402

434

For these purposes "forms" are a kind-of CV, eval""s are too (except they're

403

435

not callable at will and are always thrown away after the eval"" is done

404

executing).

436

executing). Require'd files are simply evals without any outer lexical

437

scope.

405

438

XSUBs don't have CvPADLIST set - dXSTARG fetches values from PL_curpad,

406

439

but that is really the callers pad (a slot of which is allocated by

407

440

every entersub).

415

448

The 0'th slot of a frame AV is an AV which is @_.

416

449

other entries are storage for variables and op targets.

417

450

During compilation:

418

<code class="inline">PL_comppad_name</code>

451

<code class="inline">PL_comppad_name</code>

419

452

is set to the names AV.

420

<code class="inline">PL_comppad</code>

453

<code class="inline">PL_comppad</code>

421

454

is set to the frame AV for the frame CvDEPTH == 1.

422

<code class="inline">PL_curpad</code>

455

<code class="inline">PL_curpad</code>

423

456

is set to the body of the frame AV (i.e. AvARRAY(PL_comppad)).

424

During execution, <code class="inline">PL_comppad</code>

425

and <code class="inline">PL_curpad</code>

457

During execution, <code class="inline">PL_comppad</code>

458

and <code class="inline">PL_curpad</code>

426

459

refer to the live

427

460

frame of the currently executing sub.

428

461

Iterating over the names AV iterates over all possible pad

436

469

but only by their index allocated at compile time (which is usually

437

470

in PL_op->op_targ), wasting a name SV for them doesn't make sense.

438

471

The SVs in the names AV have their PV being the name of the variable.

439

NV+1..IV inclusive is a range of cop_seq numbers for which the name is

440

valid. For typed lexicals name SV is SVt_PVMG and SvSTASH points at the

441

type. For <code class="inline"><a class="l_k" href="functions/our.html">our</a></code> lexicals, the type is SVt_PVGV, and GvSTASH points at the

442

stash of the associated global (so that duplicate <code class="inline"><a class="l_k" href="functions/our.html">our</a></code> declarations in the

443

same package can be detected). SvCUR is sometimes hijacked to

444

store the generation number during compilation.

445

If SvFAKE is set on the name SV then slot in the frame AVs are

446

a REFCNT'ed references to a lexical from "outside". In this case,

447

the name SV does not have a cop_seq range, since it is in scope

448

throughout.

472

xlow+1..xhigh inclusive in the NV union is a range of cop_seq numbers for

473

which the name is valid. For typed lexicals name SV is SVt_PVMG and SvSTASH

474

points at the type. For <code class="inline"><a class="l_k" href="functions/our.html">our</a></code> lexicals, the type is also SVt_PVMG, with the

475

SvOURSTASH slot pointing at the stash of the associated global (so that

476

duplicate <code class="inline"><a class="l_k" href="functions/our.html">our</a></code> declarations in the same package can be detected). SvUVX is

477

sometimes hijacked to store the generation number during compilation.

478

If SvFAKE is set on the name SV, then that slot in the frame AV is

479

a REFCNT'ed reference to a lexical from "outside". In this case,

480

the name SV does not use xlow and xhigh to store a cop_seq range, since it is

481

in scope throughout. Instead xhigh stores some flags containing info about

482

the real lexical (is it declared in an anon, and is it capable of being

483

instantiated multiple times?), and for fake ANONs, xlow contains the index

484

within the parent's pad where the lexical's value is stored, to make

485

cloning quicker.

449

486

If the 'name' is '&' the corresponding entry in frame AV

450

487

is a CV representing a possible closure.

451

488

(SvFAKE and name of '&' is not a meaningful combination currently but could

452

489

become so if <code class="inline"><a name="foo"></a><a class="l_k" href="functions/my.html">my</a> sub foo {}</code>

453

490

is implemented.)

491

Note that formats are treated as anon subs, and are cloned each time

492

write is called (if necessary).

454

493

The flag SVf_PADSTALE is cleared on lexicals each time the my() is executed,

455

494

and set on scope exit. This allows the 'Variable $x is not available' warning

456

to be generated in evals, such as

495

to be generated in evals, such as

457

496

458

<pre class="verbatim"> AV * CvPADLIST(CV *cv)</pre>

497

<pre class="verbatim"> AV * CvPADLIST(CV *cv)</pre>

459

498

</li>

460

<li><a name="cv_clone-cv_clone"></a>cv_clone

499

<li><a name="cv_clone"></a>cv_clone

461

500

462

501

Clone a CV: make a new CV which points to the same code etc, but which

463

502

has a newly-created pad built by copying the prototype pad and capturing

464

503

any outer lexicals.

465

<pre class="verbatim"> CV* cv_clone(CV* proto)</pre>

504

<pre class="verbatim"> CV* cv_clone(CV* proto)</pre>

466

505

</li>

467

<li><a name="cv_dump-cv_dump"></a>cv_dump

506

<li><a name="cv_dump"></a>cv_dump

468

507

469

508

dump the contents of a CV

470

<pre class="verbatim"> void cv_dump(const CV *cv, const char *title)</pre>

509

<pre class="verbatim"> void cv_dump(const CV *cv, const char *title)</pre>

471

510

</li>

472

<li><a name="do_dump_pad-do_dump_pad"></a>do_dump_pad

511

<li><a name="do_dump_pad"></a>do_dump_pad

473

512

474

513

Dump the contents of a padlist

475

<pre class="verbatim"> void do_dump_pad(I32 level, <a class="l_w" href="PerlIO.html">PerlIO</a> *file, PADLIST *padlist, <a class="l_k" href="functions/int.html">int</a> full)</pre>

514

<pre class="verbatim"> void do_dump_pad(I32 level, PerlIO *file, PADLIST *padlist, <a class="l_k" href="functions/int.html">int</a> full)</pre>

476

515

</li>

477

<li><a name="intro_my-intro_my"></a>intro_my

516

<li><a name="intro_my"></a>intro_my

478

517

479

518

"Introduce" my variables to visible status.

480

<pre class="verbatim"> U32 intro_my()</pre>

519

<pre class="verbatim"> U32 intro_my()</pre>

481

520

</li>

482

<li><a name="pad_add_anon-pad_add_anon"></a>pad_add_anon

521

<li><a name="pad_add_anon"></a>pad_add_anon

483

522

484

523

Add an anon code entry to the current compiling pad

485

<pre class="verbatim"> PADOFFSET pad_add_anon(SV* sv, OPCODE op_type)</pre>

524

<pre class="verbatim"> PADOFFSET pad_add_anon(SV* sv, OPCODE op_type)</pre>

486

525

</li>

487

<li><a name="pad_add_name-pad_add_name"></a>pad_add_name

526

<li><a name="pad_add_name"></a>pad_add_name

488

527

489

Create a new name in the current pad at the specified offset.

490

If <code class="inline">typestash</code>

528

Create a new name and associated PADMY SV in the current pad; return the

529

offset.

530

If <code class="inline">typestash</code>

491

531

is valid, the name is for a typed lexical; set the

492

532

name's stash to that value.

493

If <code class="inline">ourstash</code>

533

If <code class="inline">ourstash</code>

494

534

is valid, it's an our lexical, set the name's

495

GvSTASH to that value

496

Also, if the name is @.. or %.., create a new array or hash for that slot

535

SvOURSTASH to that value

497

536

If fake, it means we're cloning an existing entry

498

<pre class="verbatim"> PADOFFSET pad_add_name(char *name, HV* typestash, HV* ourstash, bool clone)</pre>

537

<pre class="verbatim"> PADOFFSET pad_add_name(const char *name, HV* typestash, HV* ourstash, bool clone, bool state)</pre>

499

538

</li>

500

<li><a name="pad_alloc-pad_alloc"></a>pad_alloc

539

<li><a name="pad_alloc"></a>pad_alloc

501

540

502

541

Allocate a new my or tmp pad entry. For a my, simply push a null SV onto

503

542

the end of PL_comppad, but for a tmp, scan the pad from PL_padix upwards

504

543

for a slot which has no name and no active value.

505

<pre class="verbatim"> PADOFFSET pad_alloc(I32 optype, U32 tmptype)</pre>

544

<pre class="verbatim"> PADOFFSET pad_alloc(I32 optype, U32 tmptype)</pre>

506

545

</li>

507

<li><a name="pad_block_start-pad_block_start"></a>pad_block_start

546

<li><a name="pad_block_start"></a>pad_block_start

508

547

509

548

Update the pad compilation state variables on entry to a new block

510

<pre class="verbatim"> void pad_block_start(<a class="l_k" href="functions/int.html">int</a> full)</pre>

549

<pre class="verbatim"> void pad_block_start(<a class="l_k" href="functions/int.html">int</a> full)</pre>

511

550

</li>

512

<li><a name="pad_check_dup-pad_check_dup"></a>pad_check_dup

551

<li><a name="pad_check_dup"></a>pad_check_dup

513

552

514

553

Check for duplicate declarations: report any of:

515

554

* a my in the current scope with the same name;

516

555

* an our (anywhere in the pad) with the same name and the same stash

517

as <code class="inline">ourstash</code>

556

as <code class="inline">ourstash</code>

518

557

519

558

520

559

indicates that the name to check is an 'our' declaration

521

<pre class="verbatim"> void pad_check_dup(char* name, bool is_our, HV* ourstash)</pre>

560

<pre class="verbatim"> void pad_check_dup(const char* name, bool is_our, const HV* ourstash)</pre>

522

561

</li>

523

<li><a name="pad_findlex-pad_findlex"></a>pad_findlex

562

<li><a name="pad_findlex"></a>pad_findlex

524

563

525

564

Find a named lexical anywhere in a chain of nested pads. Add fake entries

526

in the inner pads if it's found in an outer one. innercv is the CV *inside*

527

the chain of outer CVs to be searched. If newoff is non-null, this is a

528

run-time cloning: don't add fake entries, just find the lexical and add a

529

ref to it at newoff in the current pad.

530

<pre class="verbatim"> PADOFFSET pad_findlex(const char* name, PADOFFSET newoff, const CV* innercv)</pre>

565

in the inner pads if it's found in an outer one.

566

Returns the offset in the bottom pad of the lex or the fake lex.

567

cv is the CV in which to start the search, and seq is the current cop_seq

568

to match against. If warn is true, print appropriate warnings. The out_*

569

vars return values, and so are pointers to where the returned values

570

should be stored. out_capture, if non-null, requests that the innermost

571

instance of the lexical is captured; out_name_sv is set to the innermost

572

matched namesv or fake namesv; out_flags returns the flags normally

573

associated with the IVX field of a fake namesv.

574

Note that pad_findlex() is recursive; it recurses up the chain of CVs,

575

then comes back down, adding fake entries as it goes. It has to be this way

576

because fake namesvs in anon protoypes have to store in xlow the index into

577

the parent pad.

578

<pre class="verbatim"> PADOFFSET pad_findlex(const char *name, const CV* cv, U32 seq, <a class="l_k" href="functions/int.html">int</a> <a class="l_k" href="functions/warn.html">warn</a>, SV** out_capture, SV** out_name_sv, <a class="l_k" href="functions/int.html">int</a> *out_flags)</pre>

531

579

</li>

532

<li><a name="pad_findmy-pad_findmy"></a>pad_findmy

580

<li><a name="pad_findmy"></a>pad_findmy

533

581

534

582

Given a lexical name, try to find its offset, first in the current pad,

535

583

or failing that, in the pads of any lexically enclosing subs (including

536

584

the complications introduced by eval). If the name is found in an outer pad,

537

585

then a fake entry is added to the current pad.

538

586

Returns the offset in the current pad, or NOT_IN_PAD on failure.

539

<pre class="verbatim"> PADOFFSET pad_findmy(char* name)</pre>

587

<pre class="verbatim"> PADOFFSET pad_findmy(const char* name)</pre>

540

588

</li>

541

<li><a name="pad_fixup_inner_anons-pad_fixup_inner_anons"></a>pad_fixup_inner_anons

589

<li><a name="pad_fixup_inner_anons"></a>pad_fixup_inner_anons

542

590

543

591

For any anon CVs in the pad, change CvOUTSIDE of that CV from

544

592

old_cv to new_cv if necessary. Needed when a newly-compiled CV has to be

545

593

moved to a pre-existing CV struct.

546

<pre class="verbatim"> void pad_fixup_inner_anons(PADLIST *padlist, CV *old_cv, CV *new_cv)</pre>

594

<pre class="verbatim"> void pad_fixup_inner_anons(PADLIST *padlist, CV *old_cv, CV *new_cv)</pre>

547

595

</li>

548

<li><a name="pad_free-pad_free"></a>pad_free

596

<li><a name="pad_free"></a>pad_free

549

597

550

598

Free the SV at offset po in the current pad.

551

<pre class="verbatim"> void pad_free(PADOFFSET po)</pre>

599

<pre class="verbatim"> void pad_free(PADOFFSET po)</pre>

552

600

</li>

553

<li><a name="pad_leavemy-pad_leavemy"></a>pad_leavemy

601

<li><a name="pad_leavemy"></a>pad_leavemy

554

602

555

603

Cleanup at end of scope during compilation: set the max seq number for

556

604

lexicals in this scope and warn of any lexicals that never got introduced.

557

<pre class="verbatim"> void pad_leavemy()</pre>

605

<pre class="verbatim"> void pad_leavemy()</pre>

558

606

</li>

559

<li><a name="pad_new-pad_new"></a>pad_new

607

<li><a name="pad_new"></a>pad_new

560

608

561

609

Create a new compiling padlist, saving and updating the various global

562

610

vars at the same time as creating the pad itself. The following flags

563

611

can be OR'ed together:

564

<pre class="verbatim"> padnew_CLONE this pad is for a cloned CV

565

padnew_SAVE save old globals

566

padnew_SAVESUB also save extra stuff for start of <a class="l_k" href="functions/sub.html">sub</a></pre>

567

<pre class="verbatim"> PADLIST* pad_new(<a class="l_k" href="functions/int.html">int</a> flags)</pre>

612

<pre class="verbatim"> padnew_CLONE this pad is for a cloned CV

613

padnew_SAVE save old globals

614

padnew_SAVESUB also save extra stuff for start of <a class="l_k" href="functions/sub.html">sub</a></pre>

615

<pre class="verbatim"> PADLIST* pad_new(<a class="l_k" href="functions/int.html">int</a> flags)</pre>

568

616

</li>

569

<li><a name="pad_push-pad_push"></a>pad_push

617

<li><a name="pad_push"></a>pad_push

570

618

571

619

Push a new pad frame onto the padlist, unless there's already a pad at

572

this depth, in which case don't bother creating a new one.

573

If has_args is true, give the new pad an @_ in slot zero.

574

<pre class="verbatim"> void pad_push(PADLIST *padlist, <a class="l_k" href="functions/int.html">int</a> depth, <a class="l_k" href="functions/int.html">int</a> has_args)</pre>

620

this depth, in which case don't bother creating a new one. Then give

621

the new pad an @_ in slot zero.

622

<pre class="verbatim"> void pad_push(PADLIST *padlist, <a class="l_k" href="functions/int.html">int</a> depth)</pre>

575

623

</li>

576

<li><a name="pad_reset-pad_reset"></a>pad_reset

624

<li><a name="pad_reset"></a>pad_reset

577

625

578

626

Mark all the current temporaries for reuse

579

<pre class="verbatim"> void pad_reset()</pre>

627

<pre class="verbatim"> void pad_reset()</pre>

580

628

</li>

581

<li><a name="pad_setsv-pad_setsv"></a>pad_setsv

629

<li><a name="pad_setsv"></a>pad_setsv

582

630

583

631

Set the entry at offset po in the current pad to sv.

584

632

Use the macro PAD_SETSV() rather than calling this function directly.

585

<pre class="verbatim"> void pad_setsv(PADOFFSET po, SV* sv)</pre>

633

<pre class="verbatim"> void pad_setsv(PADOFFSET po, SV* sv)</pre>

586

634

</li>

587

<li><a name="pad_swipe-pad_swipe"></a>pad_swipe

635

<li><a name="pad_swipe"></a>pad_swipe

588

636

589

637

Abandon the tmp in the current pad at offset po and replace with a

590

638

new one.

591

<pre class="verbatim"> void pad_swipe(PADOFFSET po, bool refadjust)</pre>

639

<pre class="verbatim"> void pad_swipe(PADOFFSET po, bool refadjust)</pre>

592

640

</li>

593

<li><a name="pad_tidy-pad_tidy"></a>pad_tidy

641

<li><a name="pad_tidy"></a>pad_tidy

594

642

595

643

Tidy up a pad after we've finished compiling it:

596

644

* remove most stuff from the pads of anonsub prototypes;

597

645

* give it a @_;

598

646

* mark tmps as such.

599

<pre class="verbatim"> void pad_tidy(padtidy_type type)</pre>

647

<pre class="verbatim"> void pad_tidy(padtidy_type type)</pre>

600

648

</li>

601

<li><a name="pad_undef-pad_undef"></a>pad_undef

649

<li><a name="pad_undef"></a>pad_undef

602

650

603

651

Free the padlist associated with a CV.

604

652

If parts of it happen to be current, we null the relevant

607

655

inner subs to the outer of this cv.

608

656

(This function should really be called pad_free, but the name was already

609

657

taken)

610

<pre class="verbatim"> void pad_undef(CV* cv)</pre>

658

<pre class="verbatim"> void pad_undef(CV* cv)</pre>

659

</li>

660

</ul>

661

<a name="Per-Interpreter-Variables"></a><h1>Per-Interpreter Variables</h1>

662

<ul>

663

<li><a name="PL_DBsingle"></a>PL_DBsingle

664

665

When Perl is run in debugging mode, with the -d switch, this SV is a

666

boolean which indicates whether subs are being single-stepped.

667

Single-stepping is automatically turned on after every step. This is the C

668

variable which corresponds to Perl's $DB::single variable. See

669

<code class="inline">PL_DBsub</code>

670

.

671

<pre class="verbatim"> SV * PL_DBsingle</pre>

672

</li>

673

<li><a name="PL_DBsub"></a>PL_DBsub

674

675

When Perl is run in debugging mode, with the -d switch, this GV contains

676

the SV which holds the name of the sub being debugged. This is the C

677

variable which corresponds to Perl's $DB::sub variable. See

678

<code class="inline">PL_DBsingle</code>

679

.

680

<pre class="verbatim"> GV * PL_DBsub</pre>

681

</li>

682

<li><a name="PL_DBtrace"></a>PL_DBtrace

683

684

Trace variable used when Perl is run in debugging mode, with the -d

685

switch. This is the C variable which corresponds to Perl's $DB::trace

686

variable. See <code class="inline">PL_DBsingle</code>

687

.

688

<pre class="verbatim"> SV * PL_DBtrace</pre>

689

</li>

690

<li><a name="PL_dowarn"></a>PL_dowarn

691

692

The C variable which corresponds to Perl's $^W warning variable.

693

<pre class="verbatim"> bool PL_dowarn</pre>

694

</li>

695

<li><a name="PL_last_in_gv"></a>PL_last_in_gv

696

697

The GV which was last used for a filehandle input operation. (<code class="inline"><FH></code>

698

)

699

700

</li>

701

<li><a name="PL_ofs_sv"></a>PL_ofs_sv

702

703

The output field separator - <code class="inline">$,</code>

704

in Perl space.

705

706

</li>

707

<li><a name="PL_rs"></a>PL_rs

708

709

The input record separator - <code class="inline">$/</code>

710

in Perl space.

711

611

712

</li>

612

713

</ul>

613

714

<a name="Stack-Manipulation-Macros"></a><h1>Stack Manipulation Macros</h1>

614

715

<ul>

615

<li><a name="djSP-djSP"></a>djSP

716

<li><a name="djSP"></a>djSP

616

717

617

Declare Just <code class="inline">SP</code>

618

. This is actually identical to <code class="inline">dSP</code>

718

Declare Just <code class="inline">SP</code>

719

. This is actually identical to <code class="inline">dSP</code>

619

720

, and declares

620

a local copy of perl's stack pointer, available via the <code class="inline">SP</code>

721

a local copy of perl's stack pointer, available via the <code class="inline">SP</code>

621

722

macro.

622

See <code class="inline">SP</code>

723

See <code class="inline">SP</code>

623

724

. (Available for backward source code compatibility with the

624

725

old (Perl 5.005) thread model.)

625

726

626

727

</li>

627

<li><a name="LVRET-LVRET"></a>LVRET

728

<li><a name="LVRET"></a>LVRET

628

729

629

730

True if this op will be the return value of an lvalue subroutine

630

731

</li>

631

732

</ul>

632

733

<a name="SV-Manipulation-Functions"></a><h1>SV Manipulation Functions</h1>

633

734

<ul>

634

<li><a name="report_uninit-report_uninit"></a>report_uninit

635

636

Print appropriate "Use of uninitialized variable" warning

637

<pre class="verbatim"> void report_uninit()</pre>

638

</li>

639

<li><a name="sv_add_arena-sv_add_arena"></a>sv_add_arena

735

<li><a name="sv_add_arena"></a>sv_add_arena

640

736

641

737

Given a chunk of memory, link it to the head of the list of arenas,

642

738

and split it into a list of free SVs.

643

<pre class="verbatim"> void sv_add_arena(char* ptr, U32 size, U32 flags)</pre>

739

<pre class="verbatim"> void sv_add_arena(char* ptr, U32 size, U32 flags)</pre>

644

740

</li>

645

<li><a name="sv_clean_all-sv_clean_all"></a>sv_clean_all

741

<li><a name="sv_clean_all"></a>sv_clean_all

646

742

647

743

Decrement the refcnt of each remaining SV, possibly triggering a

648

744

cleanup. This function may have to be called multiple times to free

649

745

SVs which are in complex self-referential hierarchies.

650

<pre class="verbatim"> I32 sv_clean_all()</pre>

746

<pre class="verbatim"> I32 sv_clean_all()</pre>

651

747

</li>

652

<li><a name="sv_clean_objs-sv_clean_objs"></a>sv_clean_objs

748

<li><a name="sv_clean_objs"></a>sv_clean_objs

653

749

654

750

Attempt to destroy all objects not yet freed

655

<pre class="verbatim"> void sv_clean_objs()</pre>

751

<pre class="verbatim"> void sv_clean_objs()</pre>

656

752

</li>

657

<li><a name="sv_free_arenas-sv_free_arenas"></a>sv_free_arenas

753

<li><a name="sv_free_arenas"></a>sv_free_arenas

658

754

659

755

Deallocate the memory used by all arenas. Note that all the individual SV

660

756

heads and bodies within the arenas must already have been freed.

661

<pre class="verbatim"> void sv_free_arenas()</pre>

757

<pre class="verbatim"> void sv_free_arenas()</pre>

758

</li>

759

</ul>

760

<a name="SV-Body-Allocation"></a><h1>SV-Body Allocation</h1>

761

<ul>

762

<li><a name="sv_2num"></a>sv_2num

763

764

Return an SV with the numeric value of the source SV, doing any necessary

765

reference or overload conversion. You must use the <code class="inline">SvNUM(sv)</code>

766

macro to

767

access this function.

768

769

</li>

770

</ul>

771

<a name="Unicode-Support"></a><h1>Unicode Support</h1>

772

<ul>

773

<li><a name="find_uninit_var"></a>find_uninit_var

774

775

Find the name of the undefined variable (if any) that caused the operator o

776

to issue a "Use of uninitialized value" warning.

777

If match is true, only return a name if it's value matches uninit_sv.

778

So roughly speaking, if a unary operator (such as OP_COS) generates a

779

warning, then following the direct child of the op may yield an

780

OP_PADSV or OP_GV that gives the name of the undefined variable. On the

781

other hand, with OP_ADD there are two branches to follow, so we only print

782

the variable name if we get an exact match.

783

The name is returned as a mortal SV.

784

Assumes that PL_op is the op that originally triggered the error, and that

785

PL_comppad/PL_curpad points to the currently executing pad.

786

<pre class="verbatim"> SV* find_uninit_var(OP* obase, SV* uninit_sv, bool top)</pre>

787

</li>

788

<li><a name="report_uninit"></a>report_uninit

789

790

Print appropriate "Use of uninitialized variable" warning

791

<pre class="verbatim"> void report_uninit(SV* uninit_sv)</pre>

662

792

</li>

663

793

</ul>

664

794

<a name="AUTHORS"></a><h1>AUTHORS</h1>

684

814

685

815

</form>

686

816

817

687

818

<h2>Labels:</h2>

688

819

689

820

Older »