cpython/PC/msvcrtmodule.c at main · python/cpython · GitHub

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

/*********************************************************

msvcrtmodule.c

A Python interface to the Microsoft Visual C Runtime

Library, providing access to those non-portable, but

still useful routines.

Only ever compiled with an MS compiler, so no attempt

has been made to avoid MS language extensions, etc...

This may only work on NT or 95...

Author: Mark Hammond and Guido van Rossum.

Maintenance: Guido van Rossum.

***********************************************************/

#include "Python.h"

#include "pycore_fileutils.h" // _Py_BEGIN_SUPPRESS_IPH

#include "malloc.h"

#include <io.h>

#include <conio.h>

#include <sys/locking.h>

#include <crtdbg.h>

#include <windows.h>

#ifdef _MSC_VER

#if _MSC_VER >= 1500 && _MSC_VER < 1600

#include <crtassem.h>

#elif _MSC_VER >= 1600

#include <crtversion.h>

#endif

/*[python input]

class HANDLE_return_converter(CReturnConverter):

type = 'void *'

def render(self, function, data):

self.declare(data)

self.err_occurred_if(

"_return_value == NULL || _return_value == INVALID_HANDLE_VALUE",

data)

data.return_conversion.append(

'return_value = PyLong_FromVoidPtr(_return_value);\n')

class byte_char_return_converter(CReturnConverter):

type = 'int'

def render(self, function, data):

data.declarations.append('char s[1];')

data.return_value = 's[0]'

data.return_conversion.append(

f'{data.parser_retval} = PyBytes_FromStringAndSize(s, 1);\n')

class wchar_t_return_converter(CReturnConverter):

type = 'wchar_t'

def render(self, function, data):

self.declare(data)

data.return_conversion.append(

f'{data.parser_retval} = '

f'PyUnicode_FromOrdinal({data.converter_retval});\n')

[python start generated code]*/

/*[python end generated code: output=da39a3ee5e6b4b0d input=f61ae699a69482ba]*/

/*[clinic input]

module msvcrt

[clinic start generated code]*/

/*[clinic end generated code: output=da39a3ee5e6b4b0d input=f31a87a783d036cd]*/

#include "clinic/msvcrtmodule.c.h"

/*[clinic input]

msvcrt.heapmin

Minimize the malloc() heap.

Force the malloc() heap to clean itself up and return unused blocks

to the operating system. On failure, this raises OSError.

[clinic start generated code]*/

static PyObject *

msvcrt_heapmin_impl(PyObject *module)

/*[clinic end generated code: output=1ba00f344782dc19 input=82e1771d21bde2d8]*/

{

if (_heapmin() != 0)

return PyErr_SetFromErrno(PyExc_OSError);

Py_RETURN_NONE;

}

/*[clinic input]

msvcrt.locking

fd: int

mode: int

nbytes: long

Lock part of a file based on file descriptor fd from the C runtime.

Raises OSError on failure. The locked region of the file extends from

the current file position for nbytes bytes, and may continue beyond

the end of the file. mode must be one of the LK_* constants listed

below. Multiple regions in a file may be locked at the same time, but

may not overlap. Adjacent regions are not merged; they must be unlocked

individually.

[clinic start generated code]*/

static PyObject *

msvcrt_locking_impl(PyObject *module, int fd, int mode, long nbytes)

/*[clinic end generated code: output=a4a90deca9785a03 input=e97bd15fc4a04fef]*/

{

int err;

if (PySys_Audit("msvcrt.locking", "iil", fd, mode, nbytes) < 0) {

return NULL;

}

Py_BEGIN_ALLOW_THREADS

_Py_BEGIN_SUPPRESS_IPH

err = _locking(fd, mode, nbytes);

_Py_END_SUPPRESS_IPH

Py_END_ALLOW_THREADS

if (err != 0)

return PyErr_SetFromErrno(PyExc_OSError);

Py_RETURN_NONE;

}

/*[clinic input]

msvcrt.setmode -> long

fd: int

mode as flags: int

Set the line-end translation mode for the file descriptor fd.

To set it to text mode, flags should be os.O_TEXT; for binary, it

should be os.O_BINARY.

Return value is the previous mode.

[clinic start generated code]*/

static long

msvcrt_setmode_impl(PyObject *module, int fd, int flags)

/*[clinic end generated code: output=24a9be5ea07ccb9b input=76e7c01f6b137f75]*/

{

_Py_BEGIN_SUPPRESS_IPH

flags = _setmode(fd, flags);

_Py_END_SUPPRESS_IPH

if (flags == -1)

PyErr_SetFromErrno(PyExc_OSError);

return flags;

}

/*[clinic input]

msvcrt.open_osfhandle -> long

handle: HANDLE

flags: int

Create a C runtime file descriptor from the file handle handle.

The flags parameter should be a bitwise OR of os.O_APPEND, os.O_RDONLY,

and os.O_TEXT. The returned file descriptor may be used as a parameter

to os.fdopen() to create a file object.

[clinic start generated code]*/

static long

msvcrt_open_osfhandle_impl(PyObject *module, HANDLE handle, int flags)

/*[clinic end generated code: output=646759b9fd02ca7b input=d5db190a307cf4bb]*/

{

if (PySys_Audit("msvcrt.open_osfhandle", "Ki", handle, flags) < 0) {

return -1;

}

return _Py_open_osfhandle(handle, flags);

}

/*[clinic input]

msvcrt.get_osfhandle -> HANDLE

fd: int

Return the file handle for the file descriptor fd.

Raises OSError if fd is not recognized.

[clinic start generated code]*/

static void *

msvcrt_get_osfhandle_impl(PyObject *module, int fd)

/*[clinic end generated code: output=aca01dfe24637374 input=5fcfde9b17136aa2]*/

{

if (PySys_Audit("msvcrt.get_osfhandle", "(i)", fd) < 0) {

return NULL;

}

return _Py_get_osfhandle(fd);

}

/* Console I/O */

/*[clinic input]

@permit_long_summary

msvcrt.kbhit -> long

Returns a nonzero value if a keypress is waiting to be read. Otherwise, return 0.

[clinic start generated code]*/

static long

msvcrt_kbhit_impl(PyObject *module)

/*[clinic end generated code: output=940dfce6587c1890 input=52c0c44143f3fba5]*/

{

return _kbhit();

}

/*[clinic input]

msvcrt.getch -> byte_char

Read a keypress and return the resulting character as a byte string.

Nothing is echoed to the console. This call will block if a keypress is

not already available, but will not wait for Enter to be pressed. If the

pressed key was a special function key, this will return '\000' or

'\xe0'; the next call will return the keycode. The Control-C keypress

cannot be read with this function.

[clinic start generated code]*/

static int

msvcrt_getch_impl(PyObject *module)

/*[clinic end generated code: output=a4e51f0565064a7d input=37a40cf0ed0d1153]*/

{

int ch;

Py_BEGIN_ALLOW_THREADS

ch = _getch();

Py_END_ALLOW_THREADS

return ch;

}

#ifdef MS_WINDOWS_DESKTOP

/*[clinic input]

msvcrt.getwch -> wchar_t

Wide char variant of getch(), returning a Unicode value.

[clinic start generated code]*/

static wchar_t

msvcrt_getwch_impl(PyObject *module)

/*[clinic end generated code: output=be9937494e22f007 input=27b3dec8ad823d7c]*/

{

wchar_t ch;

Py_BEGIN_ALLOW_THREADS

ch = _getwch();

Py_END_ALLOW_THREADS

return ch;

}

#endif /* MS_WINDOWS_DESKTOP */

/*[clinic input]

msvcrt.getche -> byte_char

Similar to getch(), but the keypress will be echoed if possible.

[clinic start generated code]*/

static int

msvcrt_getche_impl(PyObject *module)

/*[clinic end generated code: output=d8f7db4fd2990401 input=43311ade9ed4a9c0]*/

{

int ch;

Py_BEGIN_ALLOW_THREADS

ch = _getche();

Py_END_ALLOW_THREADS

return ch;

}

#ifdef MS_WINDOWS_DESKTOP

/*[clinic input]

msvcrt.getwche -> wchar_t

Wide char variant of getche(), returning a Unicode value.

[clinic start generated code]*/

static wchar_t

msvcrt_getwche_impl(PyObject *module)

/*[clinic end generated code: output=d0dae5ba3829d596 input=49337d59d1a591f8]*/

{

wchar_t ch;

Py_BEGIN_ALLOW_THREADS

ch = _getwche();

Py_END_ALLOW_THREADS

return ch;

}

#endif /* MS_WINDOWS_DESKTOP */

/* Raise an OSError for a failed _putch()/_putwch() call.

These functions fail, for example, when the process has no console

attached, but the CRT reports the failure without setting errno (and

without setting the Windows last error either), so fall back to a

generic error message in that case. */

static PyObject *

set_console_write_error(void)

{

if (errno != 0) {

return PyErr_SetFromErrno(PyExc_OSError);

}

PyErr_SetString(PyExc_OSError, "write to console failed");

return NULL;

}

/*[clinic input]

msvcrt.putch

char: char

Print the byte string char to the console without buffering.

[clinic start generated code]*/

static PyObject *

msvcrt_putch_impl(PyObject *module, char char_value)

/*[clinic end generated code: output=92ec9b81012d8f60 input=ec078dd10cb054d6]*/

{

int res;

_Py_BEGIN_SUPPRESS_IPH

errno = 0;

res = _putch(char_value);

_Py_END_SUPPRESS_IPH

if (res == EOF) {

return set_console_write_error();

}

Py_RETURN_NONE;

}

#ifdef MS_WINDOWS_DESKTOP

/*[clinic input]

msvcrt.putwch

unicode_char: int(accept={str})

Wide char variant of putch(), accepting a Unicode value.

[clinic start generated code]*/

static PyObject *

msvcrt_putwch_impl(PyObject *module, int unicode_char)

/*[clinic end generated code: output=a3bd1a8951d28eee input=996ccd0bbcbac4c3]*/

{

wint_t res;

_Py_BEGIN_SUPPRESS_IPH

errno = 0;

res = _putwch(unicode_char);

_Py_END_SUPPRESS_IPH

if (res == WEOF) {

return set_console_write_error();

}

Py_RETURN_NONE;

}

#endif /* MS_WINDOWS_DESKTOP */

/*[clinic input]

msvcrt.ungetch

char: char

Opposite of getch.

Cause the byte string char to be "pushed back" into the

console buffer; it will be the next character read by

getch() or getche().

[clinic start generated code]*/

static PyObject *

msvcrt_ungetch_impl(PyObject *module, char char_value)

/*[clinic end generated code: output=c6942a0efa119000 input=22f07ee9001bbf0f]*/

{

int res;

_Py_BEGIN_SUPPRESS_IPH

res = _ungetch(char_value);

_Py_END_SUPPRESS_IPH

if (res == EOF)

return PyErr_SetFromErrno(PyExc_OSError);

Py_RETURN_NONE;

}

#ifdef MS_WINDOWS_DESKTOP

/*[clinic input]

msvcrt.ungetwch

unicode_char: int(accept={str})

Wide char variant of ungetch(), accepting a Unicode value.

[clinic start generated code]*/

static PyObject *

msvcrt_ungetwch_impl(PyObject *module, int unicode_char)

/*[clinic end generated code: output=e63af05438b8ba3d input=83ec0492be04d564]*/

{

int res;

_Py_BEGIN_SUPPRESS_IPH

res = _ungetwch(unicode_char);

_Py_END_SUPPRESS_IPH

if (res == WEOF)

return PyErr_SetFromErrno(PyExc_OSError);

Py_RETURN_NONE;

}

#endif /* MS_WINDOWS_DESKTOP */

#ifdef _DEBUG

/*[clinic input]

msvcrt.CrtSetReportFile -> HANDLE

type: int

file: HANDLE

Wrapper around _CrtSetReportFile.

Only available on Debug builds.

[clinic start generated code]*/

static void *

msvcrt_CrtSetReportFile_impl(PyObject *module, int type, HANDLE file)

/*[clinic end generated code: output=55858e446d583c5f input=290809b5f19e65b9]*/

{

HANDLE res;

_Py_BEGIN_SUPPRESS_IPH

res = _CrtSetReportFile(type, file);

_Py_END_SUPPRESS_IPH

return res;

}

/*[clinic input]

msvcrt.CrtSetReportMode -> long

type: int

mode: int

Wrapper around _CrtSetReportMode.

Only available on Debug builds.

[clinic start generated code]*/

static long

msvcrt_CrtSetReportMode_impl(PyObject *module, int type, int mode)

/*[clinic end generated code: output=b2863761523de317 input=9319d29b4319426b]*/

{

int res;

_Py_BEGIN_SUPPRESS_IPH

res = _CrtSetReportMode(type, mode);

_Py_END_SUPPRESS_IPH

if (res == -1)

PyErr_SetFromErrno(PyExc_OSError);

return res;

}

/*[clinic input]

msvcrt.set_error_mode -> long

mode: int

Wrapper around _set_error_mode.

Only available on Debug builds.

[clinic start generated code]*/

static long

msvcrt_set_error_mode_impl(PyObject *module, int mode)

/*[clinic end generated code: output=ac4a09040d8ac4e3 input=046fca59c0f20872]*/

{

long res;

_Py_BEGIN_SUPPRESS_IPH

res = _set_error_mode(mode);

_Py_END_SUPPRESS_IPH

return res;

}

#endif /* _DEBUG */

#if defined(MS_WINDOWS_DESKTOP) || defined(MS_WINDOWS_APP) || defined(MS_WINDOWS_SYSTEM)

/*[clinic input]

msvcrt.GetErrorMode

Wrapper around GetErrorMode.

[clinic start generated code]*/

static PyObject *

msvcrt_GetErrorMode_impl(PyObject *module)

/*[clinic end generated code: output=3103fc6145913591 input=5a7fb083b6dd71fd]*/

{

unsigned int res;

_Py_BEGIN_SUPPRESS_IPH

res = GetErrorMode();

_Py_END_SUPPRESS_IPH

return PyLong_FromUnsignedLong(res);

}

#endif /* MS_WINDOWS_APP || MS_WINDOWS_SYSTEM */

/*[clinic input]

msvcrt.SetErrorMode

mode: unsigned_int(bitwise=True)

Wrapper around SetErrorMode.

[clinic start generated code]*/

static PyObject *

msvcrt_SetErrorMode_impl(PyObject *module, unsigned int mode)

/*[clinic end generated code: output=01d529293f00da8f input=d8b167258d32d907]*/

{

unsigned int res;

_Py_BEGIN_SUPPRESS_IPH

res = SetErrorMode(mode);

_Py_END_SUPPRESS_IPH

return PyLong_FromUnsignedLong(res);

}

/*[clinic input]

[clinic start generated code]*/

/*[clinic end generated code: output=da39a3ee5e6b4b0d input=da39a3ee5e6b4b0d]*/

/* List of functions exported by this module */

static struct PyMethodDef msvcrt_functions[] = {

MSVCRT_HEAPMIN_METHODDEF

MSVCRT_LOCKING_METHODDEF

MSVCRT_SETMODE_METHODDEF

MSVCRT_OPEN_OSFHANDLE_METHODDEF

MSVCRT_GET_OSFHANDLE_METHODDEF

MSVCRT_KBHIT_METHODDEF

MSVCRT_GETCH_METHODDEF

MSVCRT_GETCHE_METHODDEF

MSVCRT_PUTCH_METHODDEF

MSVCRT_UNGETCH_METHODDEF

MSVCRT_GETERRORMODE_METHODDEF

MSVCRT_SETERRORMODE_METHODDEF

MSVCRT_CRTSETREPORTFILE_METHODDEF

MSVCRT_CRTSETREPORTMODE_METHODDEF

MSVCRT_SET_ERROR_MODE_METHODDEF

MSVCRT_GETWCH_METHODDEF

MSVCRT_GETWCHE_METHODDEF

MSVCRT_PUTWCH_METHODDEF

MSVCRT_UNGETWCH_METHODDEF

{NULL, NULL}

};

static int

insertptr(PyObject *mod, const char *name, void *value)

{

return PyModule_Add(mod, name, PyLong_FromVoidPtr(value));

}

#define INSERTINT(MOD, NAME, VAL) do { \

if (PyModule_AddIntConstant(MOD, NAME, VAL) < 0) { \

return -1; \

} \

} while (0)

#define INSERTPTR(MOD, NAME, PTR) do { \

if (insertptr(MOD, NAME, PTR) < 0) { \

return -1; \

} \

} while (0)

#define INSERTSTR(MOD, NAME, CONST) do { \

if (PyModule_AddStringConstant(MOD, NAME, CONST) < 0) { \

return -1; \

} \

} while (0)

static int

exec_module(PyObject* m)

{

/* constants for the locking() function's mode argument */

INSERTINT(m, "LK_LOCK", _LK_LOCK);

INSERTINT(m, "LK_NBLCK", _LK_NBLCK);

INSERTINT(m, "LK_NBRLCK", _LK_NBRLCK);

INSERTINT(m, "LK_RLCK", _LK_RLCK);

INSERTINT(m, "LK_UNLCK", _LK_UNLCK);

#ifdef MS_WINDOWS_DESKTOP

INSERTINT(m, "SEM_FAILCRITICALERRORS", SEM_FAILCRITICALERRORS);

INSERTINT(m, "SEM_NOALIGNMENTFAULTEXCEPT", SEM_NOALIGNMENTFAULTEXCEPT);

INSERTINT(m, "SEM_NOGPFAULTERRORBOX", SEM_NOGPFAULTERRORBOX);

INSERTINT(m, "SEM_NOOPENFILEERRORBOX", SEM_NOOPENFILEERRORBOX);

#endif

#ifdef _DEBUG

INSERTINT(m, "CRT_WARN", _CRT_WARN);

INSERTINT(m, "CRT_ERROR", _CRT_ERROR);

INSERTINT(m, "CRT_ASSERT", _CRT_ASSERT);

INSERTINT(m, "CRTDBG_MODE_DEBUG", _CRTDBG_MODE_DEBUG);

INSERTINT(m, "CRTDBG_MODE_FILE", _CRTDBG_MODE_FILE);

INSERTINT(m, "CRTDBG_MODE_WNDW", _CRTDBG_MODE_WNDW);

INSERTINT(m, "CRTDBG_REPORT_MODE", _CRTDBG_REPORT_MODE);

INSERTPTR(m, "CRTDBG_FILE_STDERR", _CRTDBG_FILE_STDERR);

INSERTPTR(m, "CRTDBG_FILE_STDOUT", _CRTDBG_FILE_STDOUT);

INSERTPTR(m, "CRTDBG_REPORT_FILE", _CRTDBG_REPORT_FILE);

INSERTINT(m, "OUT_TO_DEFAULT", _OUT_TO_DEFAULT);

INSERTINT(m, "OUT_TO_STDERR", _OUT_TO_STDERR);

INSERTINT(m, "OUT_TO_MSGBOX", _OUT_TO_MSGBOX);

INSERTINT(m, "REPORT_ERRMODE", _REPORT_ERRMODE);

#endif

#undef INSERTINT

#undef INSERTPTR

/* constants for the crt versions */

#ifdef _VC_ASSEMBLY_PUBLICKEYTOKEN

INSERTSTR(m, "VC_ASSEMBLY_PUBLICKEYTOKEN", _VC_ASSEMBLY_PUBLICKEYTOKEN);

#endif

#ifdef _CRT_ASSEMBLY_VERSION

INSERTSTR(m, "CRT_ASSEMBLY_VERSION", _CRT_ASSEMBLY_VERSION);

#endif

#ifdef __LIBRARIES_ASSEMBLY_NAME_PREFIX

INSERTSTR(m, "LIBRARIES_ASSEMBLY_NAME_PREFIX",

__LIBRARIES_ASSEMBLY_NAME_PREFIX);

#endif

#undef INSERTSTR

/* constants for the 2010 crt versions */

#if defined(_VC_CRT_MAJOR_VERSION) && defined (_VC_CRT_MINOR_VERSION) && defined(_VC_CRT_BUILD_VERSION) && defined(_VC_CRT_RBUILD_VERSION)

PyObject *version = PyUnicode_FromFormat("%d.%d.%d.%d",

_VC_CRT_MAJOR_VERSION,

_VC_CRT_MINOR_VERSION,

_VC_CRT_BUILD_VERSION,

_VC_CRT_RBUILD_VERSION);

if (PyModule_Add(m, "CRT_ASSEMBLY_VERSION", version) < 0) {

return -1;

}

#endif

return 0;

}

static PyModuleDef_Slot msvcrt_slots[] = {

{Py_mod_exec, exec_module},

{Py_mod_multiple_interpreters, Py_MOD_PER_INTERPRETER_GIL_SUPPORTED},

{Py_mod_gil, Py_MOD_GIL_NOT_USED},

{0, NULL}

};

static struct PyModuleDef msvcrtmodule = {

.m_base = PyModuleDef_HEAD_INIT,

.m_name = "msvcrt",

.m_methods = msvcrt_functions,

.m_slots = msvcrt_slots,

};

PyMODINIT_FUNC

PyInit_msvcrt(void)

{

return PyModuleDef_Init(&msvcrtmodule);

}

cpython/PC/msvcrtmodule.c at main · python/cpython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

msvcrtmodule.c

Latest commit

History

Breadcrumbs

msvcrtmodule.c

File metadata and controls